| // *************************************************************************************************************************** |
| // * 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.assertions; |
| |
| import static org.apache.juneau.common.internal.ArgUtils.*; |
| |
| import java.io.*; |
| import java.util.function.*; |
| |
| import org.apache.juneau.cp.*; |
| import org.apache.juneau.internal.*; |
| import org.apache.juneau.serializer.*; |
| |
| /** |
| * Used for fluent assertion calls against comparable objects. |
| * |
| * <h5 class='section'>Test Methods:</h5> |
| * <p> |
| * <ul class='javatree'> |
| * <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#isJson(String) isJson(String)} |
| * <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)} |
| * <li class='jm'>{@link FluentObjectAssertion#isSameJsonAs(Object) isSameJsonAs(Object)} |
| * <li class='jm'>{@link FluentObjectAssertion#isSameSortedJsonAs(Object) isSameSortedJsonAs(Object)} |
| * <li class='jm'>{@link FluentObjectAssertion#isSameSerializedAs(Object, WriterSerializer) isSameSerializedAs(Object, WriterSerializer)} |
| * <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(WriterSerializer) asString(WriterSerializer)} |
| * <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)} |
| * <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()} |
| * <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()} |
| * <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)} |
| * <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="../../../../index.html#ja.Overview">Overview > juneau-assertions > Overview</a> |
| * </ul> |
| * |
| * @param <T> The value type |
| * @param <R> The return type. |
| */ |
| @FluentSetters(returns="FluentComparableAssertion<T,R>") |
| @SuppressWarnings("rawtypes") |
| public class FluentComparableAssertion<T extends Comparable,R> extends FluentObjectAssertion<T,R> { |
| |
| //----------------------------------------------------------------------------------------------------------------- |
| // Static |
| //----------------------------------------------------------------------------------------------------------------- |
| |
| private static final Messages MESSAGES = Messages.of(FluentComparableAssertion.class, "Messages"); |
| private static final String |
| MSG_valueWasNotGreaterThanExpected = MESSAGES.getString("valueWasNotGreaterThanExpected"), |
| MSG_valueWasNotGreaterOrEqualsToExpected = MESSAGES.getString("valueWasNotGreaterOrEqualsToExpected"), |
| MSG_valueWasNotLessThanExpected = MESSAGES.getString("valueWasNotLessThanExpected"), |
| MSG_valueWasNotLessOrEqualsToExpected = MESSAGES.getString("valueWasNotLessOrEqualsToExpected"); |
| |
| //----------------------------------------------------------------------------------------------------------------- |
| // Instance |
| //----------------------------------------------------------------------------------------------------------------- |
| |
| /** |
| * Constructor. |
| * |
| * @param value |
| * The object being tested. |
| * <br>Can be <jk>null</jk>. |
| * @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 FluentComparableAssertion(T value, R returns) { |
| this(null, value, returns); |
| } |
| |
| /** |
| * 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>. |
| * @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 FluentComparableAssertion(Assertion creator, T value, R returns) { |
| super(creator, value, returns); |
| } |
| |
| //----------------------------------------------------------------------------------------------------------------- |
| // Transform methods |
| //----------------------------------------------------------------------------------------------------------------- |
| |
| @Override /* FluentObjectAssertion */ |
| public FluentComparableAssertion<T,R> asTransformed(Function<T,T> function) { |
| return new FluentComparableAssertion<>(this, function.apply(orElse(null)), returns()); |
| } |
| |
| //----------------------------------------------------------------------------------------------------------------- |
| // Test methods |
| //----------------------------------------------------------------------------------------------------------------- |
| |
| /** |
| * Asserts that the value is greater than the specified value. |
| * |
| * @param value The values to check against. |
| * @return The fluent return object. |
| * @throws AssertionError If assertion failed. |
| */ |
| public R isGt(Comparable value) throws AssertionError { |
| assertArgNotNull("value", value); |
| if (value().compareTo(value) <= 0) |
| throw error(MSG_valueWasNotGreaterThanExpected, value, value()); |
| return returns(); |
| } |
| |
| /** |
| * Asserts that the value is greater than or equal to the specified value. |
| * |
| * @param value The values to check against. |
| * @return The fluent return object. |
| * @throws AssertionError If assertion failed. |
| */ |
| public R isGte(Comparable value) throws AssertionError { |
| assertArgNotNull("value", value); |
| if (value().compareTo(value) < 0) |
| throw error(MSG_valueWasNotGreaterOrEqualsToExpected, value, value()); |
| return returns(); |
| } |
| |
| /** |
| * Asserts that the value is less than the specified value. |
| * |
| * @param value The values to check against. |
| * @return The fluent return object. |
| * @throws AssertionError If assertion failed. |
| */ |
| public R isLt(Comparable value) throws AssertionError { |
| assertArgNotNull("value", value); |
| if (value().compareTo(value) >= 0) |
| throw error(MSG_valueWasNotLessThanExpected, value, value()); |
| return returns(); |
| } |
| |
| /** |
| * Asserts that the value is less than or equals to the specified value. |
| * |
| * @param value The values to check against. |
| * @return The fluent return object. |
| * @throws AssertionError If assertion failed. |
| */ |
| public R isLte(Comparable value) throws AssertionError { |
| assertArgNotNull("value", value); |
| if (value().compareTo(value) > 0) |
| throw error(MSG_valueWasNotLessOrEqualsToExpected, value, value()); |
| return returns(); |
| } |
| |
| /** |
| * Asserts that the value is between (inclusive) the specified upper and lower values. |
| * |
| * @param lower The lower value to check against. |
| * @param upper The upper value to check against. |
| * @return The fluent return object. |
| * @throws AssertionError If assertion failed. |
| */ |
| public R isBetween(Comparable lower, Comparable upper) throws AssertionError { |
| isExists(); |
| assertArgNotNull("lower", lower); |
| assertArgNotNull("upper", upper); |
| isLte(upper); |
| isGte(lower); |
| return returns(); |
| } |
| |
| //----------------------------------------------------------------------------------------------------------------- |
| // Fluent setters |
| //----------------------------------------------------------------------------------------------------------------- |
| |
| // <FluentSetters> |
| |
| @Override /* GENERATED - org.apache.juneau.assertions.Assertion */ |
| public FluentComparableAssertion<T,R> setMsg(String msg, Object...args) { |
| super.setMsg(msg, args); |
| return this; |
| } |
| |
| @Override /* GENERATED - org.apache.juneau.assertions.Assertion */ |
| public FluentComparableAssertion<T,R> setOut(PrintStream value) { |
| super.setOut(value); |
| return this; |
| } |
| |
| @Override /* GENERATED - org.apache.juneau.assertions.Assertion */ |
| public FluentComparableAssertion<T,R> setSilent() { |
| super.setSilent(); |
| return this; |
| } |
| |
| @Override /* GENERATED - org.apache.juneau.assertions.Assertion */ |
| public FluentComparableAssertion<T,R> setStdOut() { |
| super.setStdOut(); |
| return this; |
| } |
| |
| @Override /* GENERATED - org.apache.juneau.assertions.Assertion */ |
| public FluentComparableAssertion<T,R> setThrowable(Class<? extends java.lang.RuntimeException> value) { |
| super.setThrowable(value); |
| return this; |
| } |
| |
| // </FluentSetters> |
| } |
