/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.juneau.bct.assertions;

import java.io.*;
import java.util.function.*;

import org.apache.juneau.commons.function.*;
import org.apache.juneau.commons.utils.*;


/**
 * Used for fluent assertion calls against booleans.
 *
 * <h5 class='section'>Test Methods:</h5>
 * <p>
 * <ul class='javatree'>
 *    <li class='jc'>{@link FluentBooleanAssertion}
 *    <ul class='javatreec'>
 *       <li class='jm'>{@link FluentBooleanAssertion#isTrue() isTrue()}
 *       <li class='jm'>{@link FluentBooleanAssertion#isFalse() isFalse()}
 *    </ul>
 *    <li class='jc'>{@link FluentComparableAssertion}
 *    <ul class='javatreec'>
 *       <li class='jm'>{@link FluentComparableAssertion#isGt(Comparable) isGt(Comparable)}
 *       <li class='jm'>{@link FluentComparableAssertion#isGte(Comparable) isGte(Comparable)}
 *       <li class='jm'>{@link FluentComparableAssertion#isLt(Comparable) isLt(Comparable)}
 *       <li class='jm'>{@link FluentComparableAssertion#isLte(Comparable) isLte(Comparable)}
 *       <li class='jm'>{@link FluentComparableAssertion#isBetween(Comparable,Comparable) isBetween(Comparable,Comparable)}
  *   </ul>
 *    <li class='jc'>{@link FluentObjectAssertion}
 *    <ul class='javatreec'>
 *       <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()}
 *       <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)}
 *       <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)}
 *       <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)}
 *       <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)}
 *       <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)}
 *       <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()}
 *       <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()}
 *       <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)}
 *       <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
 *    </ul>
 * </ul>
 *
 * <h5 class='section'>Transform Methods:</h5>
 * <p>
 * <ul class='javatree'>
 *    <li class='jc'>{@link FluentObjectAssertion}
 *    <ul class='javatreec'>
 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
 *       <li class='jm'>{@link FluentObjectAssertion#asString(ThrowingFunction) asString(ThrowingFunction)}
 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(UnaryOperator) asTransformed(UnaryOperator)}
 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
 * </ul>
 * </ul>
 *
 * <h5 class='section'>Configuration Methods:</h5>
 * <p>
 * <ul class='javatree'>
 *    <li class='jc'>{@link Assertion}
 *    <ul class='javatreec'>
 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
 *    </ul>
 * </ul>
 *
 * <h5 class='section'>See Also:</h5><ul>
 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem</a>
 * </ul>
 *
 * @param <R> The return type.
 */
@SuppressWarnings({
   "java:S115" // Constants use UPPER_snakeCase convention (e.g., MSG_valueWasFalse)
})
public class FluentBooleanAssertion<R> extends FluentComparableAssertion<Boolean,R> {

   private static final Messages MESSAGES = Messages.of(FluentBooleanAssertion.class, "Messages");
   private static final String MSG_valueWasFalse = MESSAGES.getString("valueWasFalse");
   private static final String MSG_valueWasTrue = MESSAGES.getString("valueWasTrue");

   /**
    * Chained constructor.
    *
    * <p>
    * Used when transforming one assertion into another so that the assertion config can be used by the new assertion.
    *
    * @param creator
    *    The assertion that created this assertion.
    *    <br>Should be <jk>null</jk> if this is the top-level assertion.
    * @param value
    *    The object being tested.
    *    <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value).
    * @param returns
    *    The object to return after a test method is called.
    *    <br>If <jk>null</jk>, the test method returns this object allowing multiple test method calls to be
    * used on the same assertion.
    */
   public FluentBooleanAssertion(Assertion creator, Boolean value, R returns) {
      super(creator, value, returns);
   }

   /**
    * Constructor.
    *
    * @param value
    *    The object being tested.
    *    <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value).
    * @param returns
    *    The object to return after a test method is called.
    *    <br>If <jk>null</jk>, the test method returns this object allowing multiple test method calls to be
    * used on the same assertion.
    */
   public FluentBooleanAssertion(Boolean value, R returns) {
      this(null, value, returns);
   }

   /**
    * Asserts that the value is false.
    *
    * @return The fluent return object.
    * @throws AssertionError If assertion failed.
    */
   public R isFalse() throws AssertionError {
      if (ObjectUtils.isTrue(value()))
         throw error(MSG_valueWasTrue);
      return returns();
   }

   /**
    * Asserts that the value is true.
    *
    * @return The fluent return object.
    * @throws AssertionError If assertion failed.
    */
   public R isTrue() throws AssertionError {
      if (ObjectUtils.isFalse(value()))
         throw error(MSG_valueWasFalse);
      return returns();
   }

   @Override /* Overridden from Assertion */
   public FluentBooleanAssertion<R> setMsg(String msg, Object...args) {
      super.setMsg(msg, args);
      return this;
   }

   @Override /* Overridden from Assertion */
   public FluentBooleanAssertion<R> setOut(PrintStream value) {
      super.setOut(value);
      return this;
   }

   @Override /* Overridden from Assertion */
   public FluentBooleanAssertion<R> setSilent() {
      super.setSilent();
      return this;
   }

   @Override /* Overridden from Assertion */
   public FluentBooleanAssertion<R> setStdOut() {
      super.setStdOut();
      return this;
   }

   @Override /* Overridden from Assertion */
   public FluentBooleanAssertion<R> setThrowable(Class<? extends RuntimeException> value) {
      super.setThrowable(value);
      return this;
   }
}