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