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 * <h2 class='section'>Example:</h2>
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 * <h2 class='topic'>Test Methods</h2>
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 * <h2 class='topic'>Transform Methods</h2>
067 * <ul class='javatree'>
068 *    <li class='jc'>{@link FluentArrayAssertion}
069 *    <ul class='javatreec'>
070 *       <li class='jm'>{@link FluentArrayAssertion#asStrings() asStrings()}
071 *       <li class='jm'>{@link FluentArrayAssertion#asStrings(Function) asStrings(Function)}
072 *       <li class='jm'>{@link FluentArrayAssertion#asCdl() asCdl()}
073 *       <li class='jm'>{@link FluentArrayAssertion#asCdl(Function) asCdl(Function)}
074 *       <li class='jm'>{@link FluentArrayAssertion#asBeanList() asBeanList()}
075 *       <li class='jm'>{@link FluentArrayAssertion#asItem(int) asItem(int)}
076 *       <li class='jm'>{@link FluentArrayAssertion#asSorted() asSorted()}
077 *       <li class='jm'>{@link FluentArrayAssertion#asSorted(Comparator) asSorted(Comparator)}
078 *    </ul>
079 *    <li class='jc'>{@link FluentObjectAssertion}
080 *    <ul class='javatreec'>
081 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
082 *       <li class='jm'>{@link FluentObjectAssertion#asString(ThrowingFunction) asString(ThrowingFunction)}
083 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(UnaryOperator) asTransformed(UnaryOperator)}
084 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
085 * </ul>
086 * </ul>
087 *
088 * <h2 class='topic'>Configuration Methods</h2>
089 * <ul class='javatree'>
090 *    <li class='jc'>{@link Assertion}
091 *    <ul class='javatreec'>
092 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
093 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
094 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
095 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
096 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
097 *    </ul>
098 * </ul>
099 *
100 * <h2 class='section'>See Also:</h2>
101 * <ul>
102 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem</a>
103 * </ul>
104 *
105 * @param <E> The element type.
106 */
107public class ArrayAssertion<E> extends FluentArrayAssertion<E,ArrayAssertion<E>> {
108
109   /**
110    * Static creator.
111    *
112    * @param <E> The element type.
113    * @param value
114    *    The object being tested.
115    *    <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value).
116    * @return A new assertion object.
117    */
118   public static <E> ArrayAssertion<E> create(E[] value) {
119      return new ArrayAssertion<>(value);
120   }
121
122   /**
123    * Constructor.
124    *
125    * @param value
126    *    The object being tested.
127    *    <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value).
128    */
129   public ArrayAssertion(E[] value) {
130      super(value, null);
131   }
132
133   @Override /* Overridden from Assertion */
134   public ArrayAssertion<E> setMsg(String msg, Object...args) {
135      super.setMsg(msg, args);
136      return this;
137   }
138
139   @Override /* Overridden from Assertion */
140   public ArrayAssertion<E> setOut(PrintStream value) {
141      super.setOut(value);
142      return this;
143   }
144
145   @Override /* Overridden from Assertion */
146   public ArrayAssertion<E> setSilent() {
147      super.setSilent();
148      return this;
149   }
150
151   @Override /* Overridden from Assertion */
152   public ArrayAssertion<E> setStdOut() {
153      super.setStdOut();
154      return this;
155   }
156
157   @Override /* Overridden from Assertion */
158   public ArrayAssertion<E> setThrowable(Class<? extends RuntimeException> value) {
159      super.setThrowable(value);
160      return this;
161   }
162}