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.bct.assertions;
018
019import java.io.*;
020import java.util.*;
021import java.util.function.*;
022
023
024/**
025 * Used for assertion calls against arrays.
026 *
027 * <h5 class='section'>Example:</h5>
028 * <p class='bjava'>
029 *    <jk>import static</jk> org.apache.juneau.bct.assertions.Assertions.*;
030 *
031 *    String[] <jv>array</jv> = {<js>"foo"</js>};
032 *    <jsm>assertArray</jsm>(<jv>array</jv>).exists().isSize(1);
033 * </p>
034 *
035 * <h5 class='topic'>Test Methods</h5>
036 * <ul class='javatree'>
037 *    <li class='jc'>{@link FluentArrayAssertion}
038 *    <ul class='javatreec'>
039 *       <li class='jm'>{@link FluentArrayAssertion#isHas(Object[]) isHas(Object[])}
040 *       <li class='jm'>{@link FluentArrayAssertion#is(Predicate) is(Predicate)}
041 *       <li class='jm'>{@link FluentArrayAssertion#isAny(Predicate) isAny(Predicate)}
042 *       <li class='jm'>{@link FluentArrayAssertion#isAll(Predicate) isAll(Predicate)}
043 *       <li class='jm'>{@link FluentArrayAssertion#isEmpty() isEmpty()}
044 *       <li class='jm'>{@link FluentArrayAssertion#isNotEmpty() isNotEmpty()}
045 *       <li class='jm'>{@link FluentArrayAssertion#isSize(int) isSize(int)}
046 *       <li class='jm'>{@link FluentArrayAssertion#isContains(Object) isContains(Object)}
047 *       <li class='jm'>{@link FluentArrayAssertion#isNotContains(Object) isNotContains(Object)}
048 *    </ul>
049 *    <li class='jc'>{@link FluentObjectAssertion}
050 *    <ul class='javatreec'>
051 *       <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()}
052 *       <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)}
053 *       <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)}
054 *       <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)}
055 *       <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)}
056 *       <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)}
057 *       <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()}
058 *       <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()}
059 *       <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)}
060 *       <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
061 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
062 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
063 *    </ul>
064 * </ul>
065 *
066 * <h5 class='topic'>Transform Methods</h5>
067 * <p>
068 * <ul class='javatree'>
069 *    <li class='jc'>{@link FluentArrayAssertion}
070 *    <ul class='javatreec'>
071 *       <li class='jm'>{@link FluentArrayAssertion#asStrings() asStrings()}
072 *       <li class='jm'>{@link FluentArrayAssertion#asStrings(Function) asStrings(Function)}
073 *       <li class='jm'>{@link FluentArrayAssertion#asCdl() asCdl()}
074 *       <li class='jm'>{@link FluentArrayAssertion#asCdl(Function) asCdl(Function)}
075 *       <li class='jm'>{@link FluentArrayAssertion#asBeanList() asBeanList()}
076 *       <li class='jm'>{@link FluentArrayAssertion#asItem(int) asItem(int)}
077 *       <li class='jm'>{@link FluentArrayAssertion#asSorted() asSorted()}
078 *       <li class='jm'>{@link FluentArrayAssertion#asSorted(Comparator) asSorted(Comparator)}
079 *    </ul>
080 *    <li class='jc'>{@link FluentObjectAssertion}
081 *    <ul class='javatreec'>
082 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
083 *       <li class='jm'>{@link FluentObjectAssertion#asString(ThrowingFunction) asString(ThrowingFunction)}
084 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(UnaryOperator) asTransformed(UnaryOperator)}
085 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
086 * </ul>
087 * </ul>
088 *
089 * <h5 class='topic'>Configuration Methods</h5>
090 * <p>
091 * <ul class='javatree'>
092 *    <li class='jc'>{@link Assertion}
093 *    <ul class='javatreec'>
094 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
095 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
096 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
097 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
098 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
099 *    </ul>
100 * </ul>
101 *
102 * <h5 class='section'>See Also:</h5>
103 * <ul>
104 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem</a>
105 * </ul>
106 *
107 * @param <E> The element type.
108 */
109public class ArrayAssertion<E> extends FluentArrayAssertion<E,ArrayAssertion<E>> {
110
111   /**
112    * Static creator.
113    *
114    * @param <E> The element type.
115    * @param value
116    *    The object being tested.
117    *    <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value).
118    * @return A new assertion object.
119    */
120   public static <E> ArrayAssertion<E> create(E[] value) {
121      return new ArrayAssertion<>(value);
122   }
123
124   /**
125    * Constructor.
126    *
127    * @param value
128    *    The object being tested.
129    *    <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value).
130    */
131   public ArrayAssertion(E[] value) {
132      super(value, null);
133   }
134
135   @Override /* Overridden from Assertion */
136   public ArrayAssertion<E> setMsg(String msg, Object...args) {
137      super.setMsg(msg, args);
138      return this;
139   }
140
141   @Override /* Overridden from Assertion */
142   public ArrayAssertion<E> setOut(PrintStream value) {
143      super.setOut(value);
144      return this;
145   }
146
147   @Override /* Overridden from Assertion */
148   public ArrayAssertion<E> setSilent() {
149      super.setSilent();
150      return this;
151   }
152
153   @Override /* Overridden from Assertion */
154   public ArrayAssertion<E> setStdOut() {
155      super.setStdOut();
156      return this;
157   }
158
159   @Override /* Overridden from Assertion */
160   public ArrayAssertion<E> setThrowable(Class<? extends RuntimeException> value) {
161      super.setThrowable(value);
162      return this;
163   }
164}