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.function.*;
021
022import org.apache.juneau.internal.*;
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>int</jk>[] <jv>array</jv> = {1};
031 *    <jsm>assertArray</jsm>(<jv>array</jv>).exists().isSize(1);
032 * </p>
033 *
034 *
035 * <h5 class='section'>Test Methods:</h5>
036 * <p>
037 * <ul class='javatree'>
038 *    <li class='jc'>{@link FluentPrimitiveArrayAssertion}
039 *    <ul class='javatreec'>
040 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isHas(Object...) isHas(Object...)}
041 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#is(Predicate) is(Predicate)}
042 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isAny(Predicate) isAny(Predicate)}
043 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isAll(Predicate) isAll(Predicate)}
044 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isEmpty() isEmpty()}
045 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isNotEmpty() isNotEmpty()}
046 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isSize(int) isSize(int)}
047 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isContains(Object) isContains(Object)}
048 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#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='section'>Transform Methods:</h5>
072 * <p>
073 * <ul class='javatree'>
074 *    <li class='jc'>{@link FluentPrimitiveArrayAssertion}
075 *    <ul class='javatreec'>
076 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#asItem(int) asItem(int)}
077 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#asLength() asLength()}
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(WriterSerializer) asString(WriterSerializer)}
083 *       <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)}
084 *       <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()}
085 *       <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
086 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
087 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
088 * </ul>
089 * </ul>
090 *
091 * <h5 class='section'>Configuration Methods:</h5>
092 * <p>
093 * <ul class='javatree'>
094 *    <li class='jc'>{@link Assertion}
095 *    <ul class='javatreec'>
096 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
097 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
098 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
099 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
100 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
101 *    </ul>
102 * </ul>
103 *
104 * <h5 class='section'>See Also:</h5><ul>
105 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem Overview</a>
106 * </ul>
107 *
108 * @param <E> The array element type.
109 * @param <T> The array type.
110 */
111public class PrimitiveArrayAssertion<E,T> extends FluentPrimitiveArrayAssertion<E,T,PrimitiveArrayAssertion<E,T>> {
112
113   //-----------------------------------------------------------------------------------------------------------------
114   // Static
115   //-----------------------------------------------------------------------------------------------------------------
116
117   /**
118    * Static creator.
119    *
120    * @param <E> The element type.
121    * @param <T> The value type.
122    * @param value
123    *    The object being tested.
124    *    <br>Can be <jk>null</jk>.
125    * @return A new assertion object.
126    */
127   public static <E,T> PrimitiveArrayAssertion<E,T> create(T value) {
128      return new PrimitiveArrayAssertion<>(value);
129   }
130
131   //-----------------------------------------------------------------------------------------------------------------
132   // Instance
133   //-----------------------------------------------------------------------------------------------------------------
134
135   /**
136    * Constructor.
137    *
138    * @param value
139    *    The object being tested.
140    *    <br>Can be <jk>null</jk>.
141    */
142   public PrimitiveArrayAssertion(T value) {
143      super(value, null);
144   }
145
146   //-----------------------------------------------------------------------------------------------------------------
147   // Fluent setters
148   //-----------------------------------------------------------------------------------------------------------------
149   @Override /* Overridden from Assertion */
150   public PrimitiveArrayAssertion<E,T> setMsg(String msg, Object...args) {
151      super.setMsg(msg, args);
152      return this;
153   }
154
155   @Override /* Overridden from Assertion */
156   public PrimitiveArrayAssertion<E,T> setOut(PrintStream value) {
157      super.setOut(value);
158      return this;
159   }
160
161   @Override /* Overridden from Assertion */
162   public PrimitiveArrayAssertion<E,T> setSilent() {
163      super.setSilent();
164      return this;
165   }
166
167   @Override /* Overridden from Assertion */
168   public PrimitiveArrayAssertion<E,T> setStdOut() {
169      super.setStdOut();
170      return this;
171   }
172
173   @Override /* Overridden from Assertion */
174   public PrimitiveArrayAssertion<E,T> setThrowable(Class<? extends java.lang.RuntimeException> value) {
175      super.setThrowable(value);
176      return this;
177   }
178}