001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.assertions;
018
019import java.io.*;
020import java.util.*;
021import java.util.function.*;
022
023import org.apache.juneau.serializer.*;
024
025/**
026 * Used for assertion calls against arrays.
027 *
028 * <h5 class='section'>Example:</h5>
029 * <p class='bjava'>
030 *    <jk>import static</jk> org.apache.juneau.assertions.Assertions.*;
031 *
032 *    String[] <jv>array</jv> = {<js>"foo"</js>};
033 *    <jsm>assertArray</jsm>(<jv>array</jv>).exists().isSize(1);
034 * </p>
035 *
036 * <h5 class='topic'>Test Methods</h5>
037 * <ul class='javatree'>
038 *    <li class='jc'>{@link FluentArrayAssertion}
039 *    <ul class='javatreec'>
040 *       <li class='jm'>{@link FluentArrayAssertion#isHas(Object[]) isHas(Object[])}
041 *       <li class='jm'>{@link FluentArrayAssertion#is(Predicate) is(Predicate)}
042 *       <li class='jm'>{@link FluentArrayAssertion#isAny(Predicate) isAny(Predicate)}
043 *       <li class='jm'>{@link FluentArrayAssertion#isAll(Predicate) isAll(Predicate)}
044 *       <li class='jm'>{@link FluentArrayAssertion#isEmpty() isEmpty()}
045 *       <li class='jm'>{@link FluentArrayAssertion#isNotEmpty() isNotEmpty()}
046 *       <li class='jm'>{@link FluentArrayAssertion#isSize(int) isSize(int)}
047 *       <li class='jm'>{@link FluentArrayAssertion#isContains(Object) isContains(Object)}
048 *       <li class='jm'>{@link FluentArrayAssertion#isNotContains(Object) isNotContains(Object)}
049 *    </ul>
050 *    <li class='jc'>{@link FluentObjectAssertion}
051 *    <ul class='javatreec'>
052 *       <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()}
053 *       <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)}
054 *       <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)}
055 *       <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)}
056 *       <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)}
057 *       <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)}
058 *       <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()}
059 *       <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()}
060 *       <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)}
061 *       <li class='jm'>{@link FluentObjectAssertion#isJson(String) isJson(String)}
062 *       <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
063 *       <li class='jm'>{@link FluentObjectAssertion#isSameJsonAs(Object) isSameJsonAs(Object)}
064 *       <li class='jm'>{@link FluentObjectAssertion#isSameSortedJsonAs(Object) isSameSortedJsonAs(Object)}
065 *       <li class='jm'>{@link FluentObjectAssertion#isSameSerializedAs(Object, WriterSerializer) isSameSerializedAs(Object, WriterSerializer)}
066 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
067 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
068 *    </ul>
069 * </ul>
070 *
071 * <h5 class='topic'>Transform Methods</h5>
072 * <p>
073 * <ul class='javatree'>
074 *    <li class='jc'>{@link FluentArrayAssertion}
075 *    <ul class='javatreec'>
076 *       <li class='jm'>{@link FluentArrayAssertion#asStrings() asStrings()}
077 *       <li class='jm'>{@link FluentArrayAssertion#asStrings(Function) asStrings(Function)}
078 *       <li class='jm'>{@link FluentArrayAssertion#asCdl() asCdl()}
079 *       <li class='jm'>{@link FluentArrayAssertion#asCdl(Function) asCdl(Function)}
080 *       <li class='jm'>{@link FluentArrayAssertion#asBeanList() asBeanList()}
081 *       <li class='jm'>{@link FluentArrayAssertion#asItem(int) asItem(int)}
082 *       <li class='jm'>{@link FluentArrayAssertion#asSorted() asSorted()}
083 *       <li class='jm'>{@link FluentArrayAssertion#asSorted(Comparator) asSorted(Comparator)}
084 *    </ul>
085 *    <li class='jc'>{@link FluentObjectAssertion}
086 *    <ul class='javatreec'>
087 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
088 *       <li class='jm'>{@link FluentObjectAssertion#asString(WriterSerializer) asString(WriterSerializer)}
089 *       <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)}
090 *       <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()}
091 *       <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
092 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
093 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
094 * </ul>
095 * </ul>
096 *
097 * <h5 class='topic'>Configuration Methods</h5>
098 * <p>
099 * <ul class='javatree'>
100 *    <li class='jc'>{@link Assertion}
101 *    <ul class='javatreec'>
102 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
103 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
104 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
105 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
106 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
107 *    </ul>
108 * </ul>
109 *
110 * <h5 class='section'>See Also:</h5>
111 * <ul>
112 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem Overview</a>
113 * </ul>
114 *
115 * @param <E> The element type.
116 */
117public class ArrayAssertion<E> extends FluentArrayAssertion<E,ArrayAssertion<E>> {
118
119   /**
120    * Static creator.
121    *
122    * @param <E> The element type.
123    * @param value
124    *    The object being tested.
125    *    <br>Can be <jk>null</jk>.
126    * @return A new assertion object.
127    */
128   public static <E> ArrayAssertion<E> create(E[] value) {
129      return new ArrayAssertion<>(value);
130   }
131
132   /**
133    * Constructor.
134    *
135    * @param value
136    *    The object being tested.
137    *    <br>Can be <jk>null</jk>.
138    */
139   public ArrayAssertion(E[] value) {
140      super(value, null);
141   }
142
143   @Override /* Overridden from Assertion */
144   public ArrayAssertion<E> setMsg(String msg, Object...args) {
145      super.setMsg(msg, args);
146      return this;
147   }
148
149   @Override /* Overridden from Assertion */
150   public ArrayAssertion<E> setOut(PrintStream value) {
151      super.setOut(value);
152      return this;
153   }
154
155   @Override /* Overridden from Assertion */
156   public ArrayAssertion<E> setSilent() {
157      super.setSilent();
158      return this;
159   }
160
161   @Override /* Overridden from Assertion */
162   public ArrayAssertion<E> setStdOut() {
163      super.setStdOut();
164      return this;
165   }
166
167   @Override /* Overridden from Assertion */
168   public ArrayAssertion<E> setThrowable(Class<? extends java.lang.RuntimeException> value) {
169      super.setThrowable(value);
170      return this;
171   }
172}