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 generic POJOs.
026 *
027 * <p>
028 * Extends from {@link ObjectAssertion} allowing you to perform basic assertions, but adds several transform
029 * methods to convert to more-specific assertion types.
030 *
031 * <h5 class='section'>Example:</h5>
032 * <p class='bjava'>
033 *    <jk>import static</jk> org.apache.juneau.assertions.Assertions.*;
034 *
035 *    List&lt;MyBean&gt; <jv>listOfBeans</jv> = ...;
036 *    <jsm>assertList</jsm>(<jv>listOfBeans</jv>)
037 *       .asItem(1)  <jc>// Returns an AnyAssertion.</jc>
038 *       .asBean()  <jc>// Transforms to BeanAssertion.</jc>
039 *          .asProperty(<js>"foo"</js>)  <jc>// Returns an AnyAssertion.</jc>
040 *          .asString()  <jc>// Transforms to StringAssertion.</jc>
041 *             .is(<js>"bar"</js>);  <jc>// Performs test.</jc>
042 * </p>
043 *
044 *
045 * <h5 class='section'>Test Methods:</h5>
046 * <p>
047 * <ul class='javatree'>
048 *    <li class='jc'>{@link FluentObjectAssertion}
049 *       <ul class='javatreec'>
050 *          <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()}</li>
051 *          <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)}</li>
052 *          <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)}</li>
053 *          <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)}</li>
054 *          <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)}</li>
055 *          <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)}</li>
056 *          <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()}</li>
057 *          <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()}</li>
058 *          <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)}</li>
059 *          <li class='jm'>{@link FluentObjectAssertion#isJson(String) isJson(String)}</li>
060 *          <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}</li>
061 *          <li class='jm'>{@link FluentObjectAssertion#isSameJsonAs(Object) isSameJsonAs(Object)}</li>
062 *          <li class='jm'>{@link FluentObjectAssertion#isSameSortedJsonAs(Object) isSameSortedJsonAs(Object)}</li>
063 *          <li class='jm'>{@link FluentObjectAssertion#isSameSerializedAs(Object, WriterSerializer) isSameSerializedAs(Object, WriterSerializer)}</li>
064 *          <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}</li>
065 *          <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}</li>
066 *       </ul>
067 *    </li>
068 * </ul>
069 *
070 * <h5 class='section'>Transform Methods:</h5>
071 * <p>
072 * <ul class='javatree'>
073 *    <li class='jc'>{@link FluentAnyAssertion}
074 *    <ul class='javatreec'>
075 *       <li class='jm'>{@link FluentAnyAssertion#asArray(Class) asArray(Class)}
076 *       <li class='jm'>{@link FluentAnyAssertion#asIntArray() asIntArray()}
077 *       <li class='jm'>{@link FluentAnyAssertion#asLongArray() asLongArray()}
078 *       <li class='jm'>{@link FluentAnyAssertion#asShortArray() asShortArray()}
079 *       <li class='jm'>{@link FluentAnyAssertion#asFloatArray() asFloatArray()}
080 *       <li class='jm'>{@link FluentAnyAssertion#asDoubleArray() asDoubleArray()}
081 *       <li class='jm'>{@link FluentAnyAssertion#asCharArray() asCharArray()}
082 *       <li class='jm'>{@link FluentAnyAssertion#asByteArray() asByteArray()}
083 *       <li class='jm'>{@link FluentAnyAssertion#asBooleanArray() asBooleanArray()}
084 *       <li class='jm'>{@link FluentAnyAssertion#asBoolean() asBoolean()}
085 *       <li class='jm'>{@link FluentAnyAssertion#asBytes() asBytes()}
086 *       <li class='jm'>{@link FluentAnyAssertion#asCollection() asCollection()}
087 *       <li class='jm'>{@link FluentAnyAssertion#asCollection(Class) asCollection(Class)}
088 *       <li class='jm'>{@link FluentAnyAssertion#asStringList() asStringList()}
089 *       <li class='jm'>{@link FluentAnyAssertion#asComparable() asComparable()}
090 *       <li class='jm'>{@link FluentAnyAssertion#asDate() asDate()}
091 *       <li class='jm'>{@link FluentAnyAssertion#asInteger() asInteger()}
092 *       <li class='jm'>{@link FluentAnyAssertion#asLong() asLong()}
093 *       <li class='jm'>{@link FluentAnyAssertion#asList() asList()}
094 *       <li class='jm'>{@link FluentAnyAssertion#asList(Class) asList(Class)}
095 *       <li class='jm'>{@link FluentAnyAssertion#asMap() asMap()}
096 *       <li class='jm'>{@link FluentAnyAssertion#asMap(Class,Class) asMap(Class,Class)}
097 *       <li class='jm'>{@link FluentAnyAssertion#asBean() asBean()}
098 *       <li class='jm'>{@link FluentAnyAssertion#asBean(Class) asBean(Class)}
099 *       <li class='jm'>{@link FluentAnyAssertion#asBeanList(Class) asBeanList(Class)}
100 *       <li class='jm'>{@link FluentAnyAssertion#asZonedDateTime() asZonedDateTime()}
101 *    </ul>
102 *    <li class='jc'>{@link FluentObjectAssertion}
103 *    <ul class='javatreec'>
104 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
105 *       <li class='jm'>{@link FluentObjectAssertion#asString(WriterSerializer) asString(WriterSerializer)}
106 *       <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)}
107 *       <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()}
108 *       <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
109 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
110 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
111 * </ul>
112 * </ul>
113 *
114 * <h5 class='section'>Configuration Methods:</h5>
115 * <p>
116 * <ul class='javatree'>
117 *    <li class='jc'>{@link Assertion}
118 *    <ul class='javatreec'>
119 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
120 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
121 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
122 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
123 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
124 *    </ul>
125 * </ul>
126 *
127 * <h5 class='section'>See Also:</h5>
128 * <ul>
129 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem Overview</a>
130 * </ul>
131 *
132 * @param <T> The object type.
133 */
134public class AnyAssertion<T> extends FluentAnyAssertion<T,AnyAssertion<T>> {
135
136   // -----------------------------------------------------------------------------------------------------------------
137   // Static
138   // -----------------------------------------------------------------------------------------------------------------
139
140   /**
141    * Static creator.
142    *
143    * @param <T> The value type.
144    * @param value
145    *    The object being tested.
146    *    <br>Can be <jk>null</jk>.
147    * @return A new assertion object.
148    */
149   public static <T> AnyAssertion<T> create(T value) {
150      return new AnyAssertion<>(value);
151   }
152
153   // -----------------------------------------------------------------------------------------------------------------
154   // Instance
155   // -----------------------------------------------------------------------------------------------------------------
156
157   /**
158    * Constructor.
159    *
160    * @param value
161    *    The object being tested.
162    *    <br>Can be <jk>null</jk>.
163    */
164   public AnyAssertion(T value) {
165      super(value, null);
166   }
167
168   // -----------------------------------------------------------------------------------------------------------------
169   // Fluent setters
170   // -----------------------------------------------------------------------------------------------------------------
171   @Override /* Overridden from Assertion */
172   public AnyAssertion<T> setMsg(String msg, Object...args) {
173      super.setMsg(msg, args);
174      return this;
175   }
176
177   @Override /* Overridden from Assertion */
178   public AnyAssertion<T> setOut(PrintStream value) {
179      super.setOut(value);
180      return this;
181   }
182
183   @Override /* Overridden from Assertion */
184   public AnyAssertion<T> setSilent() {
185      super.setSilent();
186      return this;
187   }
188
189   @Override /* Overridden from Assertion */
190   public AnyAssertion<T> setStdOut() {
191      super.setStdOut();
192      return this;
193   }
194
195   @Override /* Overridden from Assertion */
196   public AnyAssertion<T> setThrowable(Class<? extends java.lang.RuntimeException> value) {
197      super.setThrowable(value);
198      return this;
199   }
200}