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 022 023/** 024 * Used for assertion calls against booleans. 025 * 026 * <h2 class='section'>Test Methods:</h2> 027 * <ul class='javatree'> 028 * <li class='jc'>{@link FluentBooleanAssertion} 029 * <ul class='javatreec'> 030 * <li class='jm'>{@link FluentBooleanAssertion#isTrue() isTrue()} 031 * <li class='jm'>{@link FluentBooleanAssertion#isFalse() isFalse()} 032 * </ul> 033 * <li class='jc'>{@link FluentComparableAssertion} 034 * <ul class='javatreec'> 035 * <li class='jm'>{@link FluentComparableAssertion#isGt(Comparable) isGt(Comparable)} 036 * <li class='jm'>{@link FluentComparableAssertion#isGte(Comparable) isGte(Comparable)} 037 * <li class='jm'>{@link FluentComparableAssertion#isLt(Comparable) isLt(Comparable)} 038 * <li class='jm'>{@link FluentComparableAssertion#isLte(Comparable) isLte(Comparable)} 039 * <li class='jm'>{@link FluentComparableAssertion#isBetween(Comparable,Comparable) isBetween(Comparable,Comparable)} 040 * </ul> 041 * <li class='jc'>{@link FluentObjectAssertion} 042 * <ul class='javatreec'> 043 * <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()} 044 * <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)} 045 * <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)} 046 * <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)} 047 * <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)} 048 * <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)} 049 * <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()} 050 * <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()} 051 * <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)} 052 * <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)} 053 * <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)} 054 * <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)} 055 * </ul> 056 * </ul> 057 * 058 * <h2 class='section'>Transform Methods:</h2> 059 * <ul class='javatree'> 060 * <li class='jc'>{@link FluentObjectAssertion} 061 * <ul class='javatreec'> 062 * <li class='jm'>{@link FluentObjectAssertion#asString() asString()} 063 * <li class='jm'>{@link FluentObjectAssertion#asString(ThrowingFunction) asString(ThrowingFunction)} 064 * <li class='jm'>{@link FluentObjectAssertion#asTransformed(UnaryOperator) asTransformed(UnaryOperator)} 065 * <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()} 066 * </ul> 067 * </ul> 068 * 069 * <h2 class='section'>Configuration Methods:</h2> 070 * <ul class='javatree'> 071 * <li class='jc'>{@link Assertion} 072 * <ul class='javatreec'> 073 * <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)} 074 * <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)} 075 * <li class='jm'>{@link Assertion#setSilent() setSilent()} 076 * <li class='jm'>{@link Assertion#setStdOut() setStdOut()} 077 * <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)} 078 * </ul> 079 * </ul> 080 * 081 * <h2 class='section'>See Also:</h2><ul> 082 * <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem</a> 083 * </ul> 084 */ 085@SuppressWarnings({ 086 "java:S110" // Inheritance depth acceptable for BooleanAssertion hierarchy 087}) 088public class BooleanAssertion extends FluentBooleanAssertion<BooleanAssertion> { 089 090 /** 091 * Static creator. 092 * 093 * @param value 094 * The object being tested. 095 * <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value). 096 * @return A new assertion object. 097 */ 098 public static BooleanAssertion create(Boolean value) { 099 return new BooleanAssertion(value); 100 } 101 102 /** 103 * Constructor. 104 * 105 * @param value 106 * The object being tested. 107 * <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value). 108 */ 109 public BooleanAssertion(Boolean value) { 110 super(value, null); 111 } 112 113 @Override /* Overridden from Assertion */ 114 public BooleanAssertion setMsg(String msg, Object...args) { 115 super.setMsg(msg, args); 116 return this; 117 } 118 119 @Override /* Overridden from Assertion */ 120 public BooleanAssertion setOut(PrintStream value) { 121 super.setOut(value); 122 return this; 123 } 124 125 @Override /* Overridden from Assertion */ 126 public BooleanAssertion setSilent() { 127 super.setSilent(); 128 return this; 129 } 130 131 @Override /* Overridden from Assertion */ 132 public BooleanAssertion setStdOut() { 133 super.setStdOut(); 134 return this; 135 } 136 137 @Override /* Overridden from Assertion */ 138 public BooleanAssertion setThrowable(Class<? extends RuntimeException> value) { 139 super.setThrowable(value); 140 return this; 141 } 142}