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 booleans.
027 *
028 * <h5 class='section'>Test Methods:</h5>
029 * <p>
030 * <ul class='javatree'>
031 *    <li class='jc'>{@link FluentBooleanAssertion}
032 *    <ul class='javatreec'>
033 *       <li class='jm'>{@link FluentBooleanAssertion#isTrue() isTrue()}
034 *       <li class='jm'>{@link FluentBooleanAssertion#isFalse() isFalse()}
035 *    </ul>
036 *    <li class='jc'>{@link FluentComparableAssertion}
037 *    <ul class='javatreec'>
038 *       <li class='jm'>{@link FluentComparableAssertion#isGt(Comparable) isGt(Comparable)}
039 *       <li class='jm'>{@link FluentComparableAssertion#isGte(Comparable) isGte(Comparable)}
040 *       <li class='jm'>{@link FluentComparableAssertion#isLt(Comparable) isLt(Comparable)}
041 *       <li class='jm'>{@link FluentComparableAssertion#isLte(Comparable) isLte(Comparable)}
042 *       <li class='jm'>{@link FluentComparableAssertion#isBetween(Comparable,Comparable) isBetween(Comparable,Comparable)}
043  *   </ul>
044 *    <li class='jc'>{@link FluentObjectAssertion}
045 *    <ul class='javatreec'>
046 *       <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()}
047 *       <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)}
048 *       <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)}
049 *       <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)}
050 *       <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)}
051 *       <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)}
052 *       <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()}
053 *       <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()}
054 *       <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)}
055 *       <li class='jm'>{@link FluentObjectAssertion#isJson(String) isJson(String)}
056 *       <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
057 *       <li class='jm'>{@link FluentObjectAssertion#isSameJsonAs(Object) isSameJsonAs(Object)}
058 *       <li class='jm'>{@link FluentObjectAssertion#isSameSortedJsonAs(Object) isSameSortedJsonAs(Object)}
059 *       <li class='jm'>{@link FluentObjectAssertion#isSameSerializedAs(Object, WriterSerializer) isSameSerializedAs(Object, WriterSerializer)}
060 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
061 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
062 *    </ul>
063 * </ul>
064 *
065 * <h5 class='section'>Transform Methods:</h5>
066 * <p>
067 * <ul class='javatree'>
068 *    <li class='jc'>{@link FluentObjectAssertion}
069 *    <ul class='javatreec'>
070 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
071 *       <li class='jm'>{@link FluentObjectAssertion#asString(WriterSerializer) asString(WriterSerializer)}
072 *       <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)}
073 *       <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()}
074 *       <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
075 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
076 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
077 * </ul>
078 * </ul>
079 *
080 * <h5 class='section'>Configuration Methods:</h5>
081 * <p>
082 * <ul class='javatree'>
083 *    <li class='jc'>{@link Assertion}
084 *    <ul class='javatreec'>
085 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
086 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
087 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
088 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
089 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
090 *    </ul>
091 * </ul>
092 *
093 * <h5 class='section'>See Also:</h5><ul>
094 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem Overview</a>
095 * </ul>
096 */
097public class BooleanAssertion extends FluentBooleanAssertion<BooleanAssertion> {
098
099   //-----------------------------------------------------------------------------------------------------------------
100   // Static
101   //-----------------------------------------------------------------------------------------------------------------
102
103   /**
104    * Static creator.
105    *
106    * @param value
107    *    The object being tested.
108    *    <br>Can be <jk>null</jk>.
109    * @return A new assertion object.
110    */
111   public static BooleanAssertion create(Boolean value) {
112      return new BooleanAssertion(value);
113   }
114
115   //-----------------------------------------------------------------------------------------------------------------
116   // Instance
117   //-----------------------------------------------------------------------------------------------------------------
118
119   /**
120    * Constructor.
121    *
122    * @param value
123    *    The object being tested.
124    *    <br>Can be <jk>null</jk>.
125    */
126   public BooleanAssertion(Boolean value) {
127      super(value, null);
128   }
129
130   //-----------------------------------------------------------------------------------------------------------------
131   // Fluent setters
132   //-----------------------------------------------------------------------------------------------------------------
133   @Override /* Overridden from Assertion */
134   public BooleanAssertion setMsg(String msg, Object...args) {
135      super.setMsg(msg, args);
136      return this;
137   }
138
139   @Override /* Overridden from Assertion */
140   public BooleanAssertion setOut(PrintStream value) {
141      super.setOut(value);
142      return this;
143   }
144
145   @Override /* Overridden from Assertion */
146   public BooleanAssertion setSilent() {
147      super.setSilent();
148      return this;
149   }
150
151   @Override /* Overridden from Assertion */
152   public BooleanAssertion setStdOut() {
153      super.setStdOut();
154      return this;
155   }
156
157   @Override /* Overridden from Assertion */
158   public BooleanAssertion setThrowable(Class<? extends java.lang.RuntimeException> value) {
159      super.setThrowable(value);
160      return this;
161   }
162}