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