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