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.serializer.*;
023
024/**
025 * Used for assertion calls against arrays.
026 *
027 * <h5 class='section'>Example:</h5>
028 * <p class='bjava'>
029 *    <jk>int</jk>[] <jv>array</jv> = {1};
030 *    <jsm>assertArray</jsm>(<jv>array</jv>).exists().isSize(1);
031 * </p>
032 *
033 *
034 * <h5 class='section'>Test Methods:</h5>
035 * <p>
036 * <ul class='javatree'>
037 *    <li class='jc'>{@link FluentPrimitiveArrayAssertion}
038 *    <ul class='javatreec'>
039 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isHas(Object...) isHas(Object...)}
040 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#is(Predicate) is(Predicate)}
041 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isAny(Predicate) isAny(Predicate)}
042 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isAll(Predicate) isAll(Predicate)}
043 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isEmpty() isEmpty()}
044 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isNotEmpty() isNotEmpty()}
045 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isSize(int) isSize(int)}
046 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isContains(Object) isContains(Object)}
047 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#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#isJson(String) isJson(String)}
061 *       <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
062 *       <li class='jm'>{@link FluentObjectAssertion#isSameJsonAs(Object) isSameJsonAs(Object)}
063 *       <li class='jm'>{@link FluentObjectAssertion#isSameSortedJsonAs(Object) isSameSortedJsonAs(Object)}
064 *       <li class='jm'>{@link FluentObjectAssertion#isSameSerializedAs(Object, WriterSerializer) isSameSerializedAs(Object, WriterSerializer)}
065 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
066 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
067 *    </ul>
068 * </ul>
069 *
070 * <h5 class='section'>Transform Methods:</h5>
071 * <p>
072 * <ul class='javatree'>
073 *    <li class='jc'>{@link FluentPrimitiveArrayAssertion}
074 *    <ul class='javatreec'>
075 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#asItem(int) asItem(int)}
076 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#asLength() asLength()}
077 *    </ul>
078 *    <li class='jc'>{@link FluentObjectAssertion}
079 *    <ul class='javatreec'>
080 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
081 *       <li class='jm'>{@link FluentObjectAssertion#asString(WriterSerializer) asString(WriterSerializer)}
082 *       <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)}
083 *       <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()}
084 *       <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
085 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
086 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
087 * </ul>
088 * </ul>
089 *
090 * <h5 class='section'>Configuration Methods:</h5>
091 * <p>
092 * <ul class='javatree'>
093 *    <li class='jc'>{@link Assertion}
094 *    <ul class='javatreec'>
095 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
096 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
097 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
098 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
099 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
100 *    </ul>
101 * </ul>
102 *
103 * <h5 class='section'>See Also:</h5><ul>
104 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem Overview</a>
105 * </ul>
106 *
107 * @param <E> The array element type.
108 * @param <T> The array type.
109 */
110public class PrimitiveArrayAssertion<E,T> extends FluentPrimitiveArrayAssertion<E,T,PrimitiveArrayAssertion<E,T>> {
111
112   /**
113    * Static creator.
114    *
115    * @param <E> The element type.
116    * @param <T> The value type.
117    * @param value
118    *    The object being tested.
119    *    <br>Can be <jk>null</jk>.
120    * @return A new assertion object.
121    */
122   public static <E,T> PrimitiveArrayAssertion<E,T> create(T value) {
123      return new PrimitiveArrayAssertion<>(value);
124   }
125
126   /**
127    * Constructor.
128    *
129    * @param value
130    *    The object being tested.
131    *    <br>Can be <jk>null</jk>.
132    */
133   public PrimitiveArrayAssertion(T value) {
134      super(value, null);
135   }
136
137   @Override /* Overridden from Assertion */
138   public PrimitiveArrayAssertion<E,T> setMsg(String msg, Object...args) {
139      super.setMsg(msg, args);
140      return this;
141   }
142
143   @Override /* Overridden from Assertion */
144   public PrimitiveArrayAssertion<E,T> setOut(PrintStream value) {
145      super.setOut(value);
146      return this;
147   }
148
149   @Override /* Overridden from Assertion */
150   public PrimitiveArrayAssertion<E,T> setSilent() {
151      super.setSilent();
152      return this;
153   }
154
155   @Override /* Overridden from Assertion */
156   public PrimitiveArrayAssertion<E,T> setStdOut() {
157      super.setStdOut();
158      return this;
159   }
160
161   @Override /* Overridden from Assertion */
162   public PrimitiveArrayAssertion<E,T> setThrowable(Class<? extends java.lang.RuntimeException> value) {
163      super.setThrowable(value);
164      return this;
165   }
166}