org.cp.elements.lang.LangExtensions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cp-elements Show documentation
Show all versions of cp-elements Show documentation
Java Simplified. Extensions and Useful Constructs for the Java Platform.
Codeprimate Elements (a.k.a. cp-elements) is a Java library and micro-framework used to simplify
the development of software applications written in Java. Elements packages several APIs into one
library in order to address various application concerns and aspects of software design and development
collectively and conveniently. Elements is a highly simple, yet robust and proven library built on
solid OO principles, software design patterns and best practices to effectively solve common
and reoccurring problems in software development.
/*
* Copyright 2016 Author or Authors.
*
* Licensed 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.cp.elements.lang;
import java.text.MessageFormat;
import java.util.Collection;
import java.util.Map;
import org.cp.elements.lang.annotation.DSL;
/**
* The LangExtensions class provides methods to write natural language expressions for various conditions, such as
* equality comparisons, identity checks, null checks, negation and so on, and operations such as conversion, etc.
*
* @author John J. Blum
* @see org.cp.elements.lang.Assert
* @see org.cp.elements.lang.DslExtension
* @see org.cp.elements.lang.annotation.DSL
* @since 1.0.0
*/
@SuppressWarnings("unused")
public abstract class LangExtensions {
/**
* The assertThat operator is used to assert the state of an object, such as it's equality, identity, nullity,
* relational value, and so on.
*
* @param Class type of the object being asserted.
* @param obj Object to be asserted.
* @return an instance of the AssertThat DSL expression for making assertions about an object's state.
* @see org.cp.elements.lang.LangExtensions.AssertThatExpression
* @see org.cp.elements.lang.annotation.DSL
*/
@DSL
public static AssertThat assertThat(final T obj) {
return new AssertThatExpression<>(obj);
}
/**
* The AssertThat interface is a contract for implementation objects that assert the state of object or component
* of the application or system.
*
* @param the type of object to evaluation and perform the assertion.
* @see org.cp.elements.lang.LangExtensions.AssertThatExpression
* @see org.cp.elements.lang.LangExtensions.AssertThatWrapper
* @see org.cp.elements.lang.DslExtension
*/
public interface AssertThat extends DslExtension {
/**
* Asserts whether the object to evaluate is assignable to the given Class type. The object evaluated
* maybe a Class object, an instance of a Class or null.
*
* @param type the Class type with which to determine assignment compatibility.
* @throws AssertionFailedException if the object being evaluated is not assignable to the Class type.
* @see java.lang.Class#isAssignableFrom(Class)
* @see #isInstanceOf(Class)
*/
void isAssignableTo(Class type);
/**
* Asserts whether the object to evaluate is comparable to the given object. This assertion performs
* an equality comparison as determined by the Comparable criteria of the Class type of the objects.
*
* @param obj the Comparable object to compare with the object being evaluated.
* @throws AssertionFailedException if the object being evaluated is not comparable to the Comparable object.
* @see java.lang.Comparable#compareTo(Object)
*/
void isComparableTo(Comparable obj);
/**
* Asserts whether the object to evaluate is equal to the given object. The objects are deemed equal
* as determined by the Object.equals method.
*
* @param obj the object used in the equality comparison with the object being evaluated.
* @throws AssertionFailedException if the object being evaluated is not equal to the given object.
* @see java.lang.Object#equals(Object)
* @see #isSameAs(Object)
*/
void isEqualTo(T obj);
/**
* Asserts whether the object to evaluate is not equal to the given object. The objects are deemed unequal
* as determined by the Object.equals method.
*
* @param obj the object used in the equality comparison with the object being evaluated.
* @throws AssertionFailedException if the object being evaluated is equal to the given object.
* @see java.lang.Object#equals(Object)
* @see #isEqualTo(Object)
* @see #not()
*/
void isNotEqualTo(T obj);
/**
* Asserts whether the object to evaluate is false.
*
* @throws AssertionFailedException if the object being evaluated is not false.
* @see #isTrue()
*/
void isFalse();
/**
* Assert that the object to evaluate is greater than the given Comparable value.
*
* @param lowerBound the Comparable value used as the lower bound in the relational comparison.
* @throws AssertionFailedException if the object being evaluated is less than or equal to the lower bound.
*/
void isGreaterThan(T lowerBound);
/**
* Assert that the object to evaluate is within the range of (greater than and less than)
* the given Comparable values.
*
* @param lowerBound the Comparable value used as the lower bound in the relational comparison.
* @param upperBound the Comparable value used as the upper bound in the relational comparison.
* @throws AssertionFailedException if the object being evaluated is less than equal to the lower bound
* or greater than equal to the upper bound.
*/
void isGreaterThanAndLessThan(T lowerBound, T upperBound);
/**
* Assert that the object to evaluate is within the range of (greater than and less than equal to)
* the given Comparable values.
*
* @param lowerBound the Comparable value used as the lower bound in the relational comparison.
* @param upperBound the Comparable value used as the upper bound in the relational comparison.
* @throws AssertionFailedException if the object being evaluated is less than equal to the lower bound
* or greater than the upper bound.
*/
void isGreaterThanAndLessThanEqualTo(T lowerBound, T upperBound);
/**
* Assert that the object to evaluate is greater than or equal to the given Comparable value.
*
* @param lowerBound the Comparable value used as the lower bound in the relational comparison.
* @throws AssertionFailedException if the object being evaluated is less than the lower bound.
*/
void isGreaterThanEqualTo(T lowerBound);
/**
* Assert that the object to evaluate is within the range of (greater than equal to and less than)
* the given Comparable values.
*
* @param lowerBound the Comparable value used as the lower bound in the relational comparison.
* @param upperBound the Comparable value used as the upper bound in the relational comparison.
* @throws AssertionFailedException if the object being evaluated is less than the lower bound
* or greater than equal to the upper bound.
*/
void isGreaterThanEqualToAndLessThan(T lowerBound, T upperBound);
/**
* Assert that the object to evaluate is within the range of (greater than equal to and less than equal to)
* the given Comparable values.
*
* @param lowerBound the Comparable value used as the lower bound in the relational comparison.
* @param upperBound the Comparable value used as the upper bound in the relational comparison.
* @throws AssertionFailedException if the object being evaluated is less than the lower bound
* or greater than the upper bound.
*/
void isGreaterThanEqualToAndLessThanEqualTo(T lowerBound, T upperBound);
/**
* Asserts that the object to evaluate has actual textual information. The object's String value has text
* if and only if the value contains at least 1 character that is not whitespace.
*
* @throws AssertionFailedException if the object being evaluated has no text.
* @see #isNotBlank()
*/
void hasText();
/**
* Assert that the current Thread holds the specified lock inside a synchronized block.
*
* @param lock the Object lock that must be held by the current Thread.
* @throws AssertionFailedException if the current Thread does not hold the specified lock.
* @see java.lang.Thread#holdsLock(Object)
*/
void holdsLock(Object lock);
/**
* Asserts that the object to evaluate is an instance of the specified Class type.
*
* @param type the Class type used in the instance of check for the object being evaluated.
* @throws AssertionFailedException if the object being evaluated is not an instance of the Class type.
* @see java.lang.Class#isInstance(Object)
* @see #isAssignableTo(Class)
*/
void isInstanceOf(Class type);
/**
* Asserts that the object to evaluate is less than the given Comparable value.
*
* @param upperBound the Comparable value used as the upper bound in the relational comparison.
* @throws AssertionFailedException if the object being evaluated is not less than the upper bound.
*/
void isLessThan(T upperBound);
/**
* Asserts that the object to evaluate is outside the bounds of the given Comparable values.
*
* @param upperBound the Comparable value used as the lower upper bound in the relational comparison.
* @param lowerBound the Comparable value used as the upper lower bound in the relational comparison.
* @throws AssertionFailedException if the object being evaluated is not less than the upper bound
* or greater than the lower bound.
*/
void isLessThanOrGreaterThan(T upperBound, T lowerBound);
/**
* Asserts that the object to evaluate is outside the bounds of the given Comparable values.
*
* @param upperBound the Comparable value used as the lower upper bound in the relational comparison.
* @param lowerBound the Comparable value used as the upper lower bound in the relational comparison.
* @throws AssertionFailedException if the object being evaluated is not less than the upper bound
* or greater than equal to the lower bound.
*/
void isLessThanOrGreaterThanEqualTo(T upperBound, T lowerBound);
/**
* Asserts that the object to evaluate is less than equal to the given Comparable value.
*
* @param upperBound the Comparable value used as the upper bound in the relational comparison.
* @throws AssertionFailedException if the object being evaluated is not less than equal to the upper bound.
*/
void isLessThanEqualTo(T upperBound);
/**
* Asserts that the object to evaluate is outside the bounds of the given Comparable values.
*
* @param upperBound the Comparable value used as the lower upper bound in the relational comparison.
* @param lowerBound the Comparable value used as the upper lower bound in the relational comparison.
* @throws AssertionFailedException if the object being evaluated is not less than equal to the upper bound
* or greater than the lower bound.
*/
void isLessThanEqualToOrGreaterThan(T upperBound, T lowerBound);
/**
* Asserts that the object to evaluate is outside the bounds of the given Comparable values.
*
* @param upperBound the Comparable value used as the lower upper bound in the relational comparison.
* @param lowerBound the Comparable value used as the upper lower bound in the relational comparison.
* @throws AssertionFailedException if the object being evaluated is not less than equal to the upper bound
* or greater than equal to the lower bound.
*/
void isLessThanEqualToOrGreaterThanEqualTo(T upperBound, T lowerBound);
/**
* Assert that the object to evaluate is not blank, or rather, has text. The object String value is blank
* if it contains only whitespace characters or null.
*
* @throws AssertionFailedException if the object being evaluated is blank, or has no actual test.
* @see #hasText()
*/
void isNotBlank();
/**
* Assert that the object to evaluate is not empty. The object String value is empty if it is equal to
* the empty String.
*
* @throws AssertionFailedException if the object being evaluated is empty.
*/
void isNotEmpty();
/**
* Asserts that the object to evaluate is not null.
*
* @throws AssertionFailedException if the object being evaluated is null.
* @see #isNull()
* @see #not()
*/
void isNotNull();
/**
* Asserts that the object to evaluate is null.
*
* @throws AssertionFailedException if the object being evaluated is not null.
*/
void isNull();
/**
* Asserts that the object to evaluate is the same instance as the given object. This assertion deems the objects
* are the same as determined by the identity comparison (==).
*
* @param obj the object used in the identity comparison with the object being evaluated.
* @throws AssertionFailedException if the objects are not the same.
* @see #isEqualTo(Object)
*/
void isSameAs(T obj);
/**
* Asserts that the object to evaluate is not the same instance as the given object. This assertion deems
* the objects are not the same as determined by the identity comparison (==).
*
* @param obj the object used in the identity comparison with the object being evaluated.
* @throws AssertionFailedException if the objects are the same.
* @see #isSameAs(Object)
* @see #not()
*/
void isNotSameAs(T obj);
/**
* Asserts that the object to evaluate is true.
*
* @throws AssertionFailedException if the object being evaluated is not true.
* @see #isFalse()
*/
void isTrue();
/**
* Negates this assertion.
*
* @return a negated instance of this assertion.
*/
AssertThat not();
/**
* Throws the provided RuntimeException when an assertion fails.
*
* @param e the RuntimeException to throw when an assertion fails.
* @return this assertion instance.
*/
AssertThat throwing(RuntimeException e);
/**
* Transforms this assertion into an adapted assertion of the same type using the provided Transformer.
*
* @param assertionTransformer the Transformer used to transform this assertion into another assertion
* of the same type.
* @return an instance of AssertThat wrapping this assertion.
* @see org.cp.elements.lang.Transformer
*/
AssertThat transform(Transformer> assertionTransformer);
/**
* Uses the provided message and message arguments in the AssertionFailedException thrown when an assertion fails.
*
* @param message the String message used in the AssertionFailedException.
* @param args an array of object arguments used to populate the placeholders of the message.
* @return this assertion instance.
*/
AssertThat using(String message, Object... args);
/**
* Enables or disables this assertion based on the provided Condition.
*
* @param condition the Condition used to enable or disable this assertion at runtime.
* @return this assertion instance.
* @see org.cp.elements.lang.Condition
*/
AssertThat when(Condition condition);
}
/**
* The AssertThatExpression class is the default implementation of the AssertThat interface
* implementing all the assertion operations.
*
* @param the type of object to evaluation and perform the assertion.
*/
private static final class AssertThatExpression implements AssertThat {
private static final boolean DEFAULT_EXPECTED = true;
private static final String NOT = "not ";
private final boolean expected;
private final T obj;
private Condition condition;
private RuntimeException cause;
private String message;
private Transformer> transformer;
/* (non-Javadoc) */
private AssertThatExpression() {
this(null, DEFAULT_EXPECTED);
}
/* (non-Javadoc) */
private AssertThatExpression(final T obj) {
this(obj, DEFAULT_EXPECTED);
}
/* (non-Javadoc) */
private AssertThatExpression(final T obj, final boolean expected) {
this.obj = obj;
this.expected = expected;
this.condition = () -> true;
}
/* (non-Javadoc) */
private boolean conditionHolds() {
return condition.evaluate();
}
/* (non-Javadoc) */
private boolean notEqualToExpected(final boolean actual) {
return !(actual == expected);
}
/* (non-Javadoc) */
public void isAssignableTo(final Class type) {
if (conditionHolds()) {
if (notEqualToExpected(is(obj).assignableTo(type))) {
throwAssertionError("(%1$s) is %2$sassignable to (%3$s)", obj, negate(NOT), ObjectUtils.getName(type));
}
}
}
/* (non-Javadoc) */
@SuppressWarnings("unchecked")
public void isComparableTo(final Comparable comparable) {
if (conditionHolds()) {
if (notEqualToExpected(is((Comparable) obj).comparableTo(comparable))) {
throwAssertionError("(%1$s) is %2$scomparable to (%3$s)", obj, negate(NOT), comparable);
}
}
}
/* (non-Javadoc) */
public void isEqualTo(final T obj) {
if (conditionHolds()) {
if (notEqualToExpected(is(this.obj).equalTo(obj))) {
throwAssertionError("(%1$s) is %2$sequal to (%3$s)", this.obj, negate(NOT), obj);
}
}
}
/* (non-Javadoc) */
public void isNotEqualTo(final T obj) {
not().isEqualTo(obj);
}
/* (non-Javadoc) */
public void isFalse() {
if (conditionHolds()) {
if (notEqualToExpected(is(obj).False())) {
throwAssertionError("(%1$s) is %2$sfalse", obj, negate(NOT));
}
}
}
/* (non-Javadoc) */
public void isGreaterThan(final T lowerBound) {
if (conditionHolds()) {
if (notEqualToExpected(is(obj).greaterThan(lowerBound))) {
throwAssertionError("(%1$s) is %2$sgreater than (%3$s)", obj, negate(NOT), lowerBound);
}
}
}
/* (non-Javadoc) */
public void isGreaterThanAndLessThan(final T lowerBound, final T upperBound) {
if (conditionHolds()) {
if (notEqualToExpected(is(obj).greaterThanAndLessThan(lowerBound, upperBound))) {
throwAssertionError("(%1$s) is %2$sgreater than (%3$s) and less than (%4$s)", obj, negate(NOT),
lowerBound, upperBound);
}
}
}
/* (non-Javadoc) */
public void isGreaterThanAndLessThanEqualTo(final T lowerBound, final T upperBound) {
if (conditionHolds()) {
if (notEqualToExpected(is(obj).greaterThanAndLessThanEqualTo(lowerBound, upperBound))) {
throwAssertionError("(%1$s) is %2$sgreater than (%3$s) and less than equal to (%4$s)", obj, negate(NOT),
lowerBound, upperBound);
}
}
}
/* (non-Javadoc) */
public void isGreaterThanEqualTo(final T lowerBound) {
if (conditionHolds()) {
if (notEqualToExpected(is(obj).greaterThanEqualTo(lowerBound))) {
throwAssertionError("(%1$s) is %2$sgreater than equal to (%3$s)", obj, negate(NOT), lowerBound);
}
}
}
/* (non-Javadoc) */
public void isGreaterThanEqualToAndLessThan(final T lowerBound, final T upperBound) {
if (conditionHolds()) {
if (notEqualToExpected(is(obj).greaterThanEqualToAndLessThan(lowerBound, upperBound))) {
throwAssertionError("(%1$s) is %2$sgreater than equal to (%3$s) and less than (%4$s)", obj, negate(NOT),
lowerBound, upperBound);
}
}
}
/* (non-Javadoc) */
public void isGreaterThanEqualToAndLessThanEqualTo(final T lowerBound, final T upperBound) {
if (conditionHolds()) {
if (notEqualToExpected(is(obj).greaterThanEqualToAndLessThanEqualTo(lowerBound, upperBound))) {
throwAssertionError("(%1$s) is %2$sgreater than equal to (%3$s) and less than equal to (%4$s)",
obj, negate(NOT), lowerBound, upperBound);
}
}
}
/* (non-Javadoc) */
public void hasText() {
isNotBlank();
}
/* (non-Javadoc) */
public void holdsLock(final Object lock) {
if (conditionHolds()) {
if (notEqualToExpected(Thread.holdsLock(lock))) {
throwAssertionError("(%1$s) %2$slock (%3$s)", Thread.currentThread(),
(expected ? "does not hold " : "holds "), lock);
}
}
}
/* (non-Javadoc) */
public void isInstanceOf(final Class type) {
if (conditionHolds()) {
if (notEqualToExpected(is(obj).instanceOf(type))) {
throwAssertionError("(%1$s) is %2$san instance of (%3$s)", obj, negate(NOT), ObjectUtils.getName(type));
}
}
}
/* (non-Javadoc) */
public void isLessThan(final T upperBound) {
if (conditionHolds()) {
if (notEqualToExpected(is(obj).lessThan(upperBound))) {
throwAssertionError("(%1$s) is %2$sless than (%3$s)", obj, negate(NOT), upperBound);
}
}
}
/* (non-Javadoc) */
public void isLessThanOrGreaterThan(final T upperBound, final T lowerBound) {
if (conditionHolds()) {
if (notEqualToExpected(is(obj).lessThanOrGreaterThan(upperBound, lowerBound))) {
throwAssertionError("(%1$s) is %2$sless than (%3$s) or greater than (%4$s)", obj, negate(NOT),
upperBound, lowerBound);
}
}
}
/* (non-Javadoc) */
public void isLessThanOrGreaterThanEqualTo(final T upperBound, final T lowerBound) {
if (conditionHolds()) {
if (notEqualToExpected(is(obj).lessThanOrGreaterThanEqualTo(upperBound, lowerBound))) {
throwAssertionError("(%1$s) is %2$sless than (%3$s) or greater than equal to (%4$s)", obj, negate(NOT),
upperBound, lowerBound);
}
}
}
/* (non-Javadoc) */
public void isLessThanEqualTo(final T upperBound) {
if (conditionHolds()) {
if (notEqualToExpected(is(obj).lessThanEqualTo(upperBound))) {
throwAssertionError("(%1$s) is %2$sless than equal to (%3$s)", obj, negate(NOT), upperBound);
}
}
}
/* (non-Javadoc) */
public void isLessThanEqualToOrGreaterThan(final T upperBound, final T lowerBound) {
if (conditionHolds()) {
if (notEqualToExpected(is(obj).lessThanEqualToOrGreaterThan(upperBound, lowerBound))) {
throwAssertionError("(%1$s) is %2$sless than equal to (%3$s) or greater than (%4$s)", obj, negate(NOT),
upperBound, lowerBound);
}
}
}
/* (non-Javadoc) */
public void isLessThanEqualToOrGreaterThanEqualTo(final T upperBound, final T lowerBound) {
if (conditionHolds()) {
if (notEqualToExpected(is(obj).lessThanEqualToOrGreaterThanEqualTo(upperBound, lowerBound))) {
throwAssertionError("(%1$s) is %2$sless than equal to (%3$s) or greater than equal to (%4$s)",
obj, negate(NOT), upperBound, lowerBound);
}
}
}
/* (non-Javadoc) */
public void isNotBlank() {
if (conditionHolds()) {
if (notEqualToExpected(is(obj).notBlank())) {
throwAssertionError("(%1$s) is %2$sblank", obj, (expected ? StringUtils.EMPTY_STRING : NOT));
}
}
}
/* (non-Javadoc) */
public void isNotEmpty() {
if (conditionHolds()) {
if (notEqualToExpected(is(obj).notEmpty())) {
throwAssertionError("(%1$s) is %2$sempty", obj, (expected ? StringUtils.EMPTY_STRING : NOT));
}
}
}
/* (non-Javadoc) */
public void isNotNull() {
not().isNull();
}
/* (non-Javadoc) */
public void isNull() {
if (conditionHolds()) {
if (notEqualToExpected(is(obj).Null())) {
throwAssertionError("(%1$s) is %2$snull", obj, negate(NOT));
}
}
}
/* (non-Javadoc) */
public void isSameAs(final T obj) {
if (conditionHolds()) {
if (notEqualToExpected(is(this.obj).sameAs(obj))) {
throwAssertionError("(%1$s) is %2$sthe same as (%3$s)", this.obj, negate(NOT), obj);
}
}
}
/* (non-Javadoc) */
public void isNotSameAs(final T obj) {
not().isSameAs(obj);
}
/* (non-Javadoc) */
public void isTrue() {
if (conditionHolds()) {
if (notEqualToExpected(is(obj).True())) {
throwAssertionError("(%1$s) is %2$strue", obj, negate(NOT));
}
}
}
/* (non-Javadoc) */
public AssertThat not() {
AssertThat expression = new AssertThatExpression<>(obj, !expected);
expression = (transformer != null ? transformer.transform(expression) : expression);
expression = expression.throwing(cause);
expression = (message != null ? expression.using(message) : expression);
expression = expression.when(this.condition);
return expression;
}
/* (non-Javadoc) */
public AssertThat throwing(final RuntimeException cause) {
this.cause = cause;
return this;
}
/* (non-Javadoc) */
@Override
public AssertThat transform(final Transformer> assertionTransformer) {
this.transformer = assertionTransformer;
return assertionTransformer.transform(this);
}
/* (non-Javadoc) */
public AssertThat using(final String message, final Object... args) {
this.message = format(message, args);
return this;
}
/* (non-Javadoc) */
public AssertThat when(final Condition condition) {
this.condition = (condition != null ? condition : () -> true);
return this;
}
/* (non-Javadoc) */
private String format(final String message, final Object... args) {
return stringFormat(messageFormat(message, args), args);
}
/* (non-Javadoc) */
private String messageFormat(final String message, final Object... args) {
return MessageFormat.format(message, args);
}
/* (non-Javadoc) */
private String stringFormat(final String message, final Object... args) {
return String.format(message, args);
}
/* (non-Javadoc) */
private String negate(final String value) {
return (expected ? value : "");
}
/* (non-Javadoc) */
private void throwAssertionError(final String defaultMessage, final Object... args) {
throw (is(cause).notNull() ? cause : new AssertionFailedException(withMessage(defaultMessage, args)));
}
/* (non-Javadoc) */
private String withMessage(final String defaultMessage, final Object... args) {
return (is(message).notBlank() ? message : format(defaultMessage, args));
}
}
/**
* The AssertThatWrapper class is a Decorator used to decorate or modify the existing behavior and/or functionality
* of an existing assertion (AssertThat instance). This class makes it easier to extend and customize any existing
* assertion in the transform(..) operation.
*
* @param the type of object to evaluation and perform the assertion.
*/
public static class AssertThatWrapper implements AssertThat {
private final AssertThat delegate;
/* (non-Javadoc) */
public AssertThatWrapper(final AssertThat delegate) {
Assert.notNull(delegate, "delegate must not be null");
this.delegate = delegate;
}
/* (non-Javadoc) */
public static AssertThat wrap(AssertThat delegate) {
return new AssertThatWrapper<>(delegate);
}
/* (non-Javadoc) */
protected AssertThat getDelegate() {
return delegate;
}
/* (non-Javadoc) */
@Override
public void isAssignableTo(final Class type) {
getDelegate().isAssignableTo(type);
}
/* (non-Javadoc) */
@Override
public void isComparableTo(final Comparable obj) {
getDelegate().isComparableTo(obj);
}
/* (non-Javadoc) */
@Override
public void isEqualTo(final T obj) {
getDelegate().isEqualTo(obj);
}
/* (non-Javadoc) */
@Override
public void isNotEqualTo(final T obj) {
getDelegate().isNotEqualTo(obj);
}
/* (non-Javadoc) */
@Override
public void isFalse() {
getDelegate().isFalse();
}
/* (non-Javadoc) */
@Override
public void isGreaterThan(final T lowerBound) {
getDelegate().isGreaterThan(lowerBound);
}
/* (non-Javadoc) */
@Override
public void isGreaterThanAndLessThan(final T lowerBound, final T upperBound) {
getDelegate().isGreaterThanAndLessThan(lowerBound, upperBound);
}
/* (non-Javadoc) */
@Override
public void isGreaterThanAndLessThanEqualTo(final T lowerBound, final T upperBound) {
getDelegate().isGreaterThanAndLessThanEqualTo(lowerBound, upperBound);
}
/* (non-Javadoc) */
@Override
public void isGreaterThanEqualTo(final T lowerBound) {
getDelegate().isGreaterThanEqualTo(lowerBound);
}
/* (non-Javadoc) */
@Override
public void isGreaterThanEqualToAndLessThan(final T lowerBound, final T upperBound) {
getDelegate().isGreaterThanEqualToAndLessThan(lowerBound, upperBound);
}
/* (non-Javadoc) */
@Override
public void isGreaterThanEqualToAndLessThanEqualTo(final T lowerBound, final T upperBound) {
getDelegate().isGreaterThanEqualToAndLessThanEqualTo(lowerBound, upperBound);
}
/* (non-Javadoc) */
@Override
public void hasText() {
getDelegate().hasText();
}
/* (non-Javadoc) */
@Override
public void holdsLock(final Object lock) {
getDelegate().holdsLock(lock);
}
/* (non-Javadoc) */
@Override
public void isInstanceOf(final Class type) {
getDelegate().isInstanceOf(type);
}
/* (non-Javadoc) */
@Override
public void isLessThan(final T upperBound) {
getDelegate().isLessThan(upperBound);
}
/* (non-Javadoc) */
@Override
public void isLessThanOrGreaterThan(final T upperBound, final T lowerBound) {
getDelegate().isLessThanOrGreaterThan(upperBound, lowerBound);
}
/* (non-Javadoc) */
@Override
public void isLessThanOrGreaterThanEqualTo(final T upperBound, final T lowerBound) {
getDelegate().isLessThanOrGreaterThanEqualTo(upperBound, lowerBound);
}
/* (non-Javadoc) */
@Override
public void isLessThanEqualTo(final T upperBound) {
getDelegate().isLessThanEqualTo(upperBound);
}
/* (non-Javadoc) */
@Override
public void isLessThanEqualToOrGreaterThan(final T upperBound, final T lowerBound) {
getDelegate().isLessThanEqualToOrGreaterThan(upperBound, lowerBound);
}
/* (non-Javadoc) */
@Override
public void isLessThanEqualToOrGreaterThanEqualTo(final T upperBound, final T lowerBound) {
getDelegate().isLessThanEqualToOrGreaterThanEqualTo(upperBound, lowerBound);
}
/* (non-Javadoc) */
@Override
public void isNotBlank() {
getDelegate().isNotBlank();
}
/* (non-Javadoc) */
@Override
public void isNotEmpty() {
getDelegate().isNotEmpty();
}
/* (non-Javadoc) */
@Override
public void isNotNull() {
getDelegate().isNotNull();
}
/* (non-Javadoc) */
@Override
public void isNull() {
getDelegate().isNull();
}
/* (non-Javadoc) */
@Override
public void isSameAs(final T obj) {
getDelegate().isSameAs(obj);
}
/* (non-Javadoc) */
@Override
public void isNotSameAs(final T obj) {
getDelegate().isNotSameAs(obj);
}
/* (non-Javadoc) */
@Override
public void isTrue() {
getDelegate().isTrue();
}
/* (non-Javadoc) */
@Override
public AssertThat not() {
return new AssertThatWrapper<>(getDelegate().not());
}
/* (non-Javadoc) */
@Override
public AssertThat throwing(final RuntimeException e) {
getDelegate().throwing(e);
return this;
}
/* (non-Javadoc) */
@Override
public AssertThat transform(final Transformer> assertionTransformer) {
return new AssertThatWrapper<>(assertionTransformer.transform(getDelegate()));
}
/* (non-Javadoc) */
@Override
public AssertThat using(final String message, final Object... args) {
getDelegate().using(message, args);
return this;
}
/* (non-Javadoc) */
@Override
public AssertThat when(final Condition condition) {
getDelegate().when(condition);
return this;
}
}
/**
* The is operator can be used to make logical determinations about an object such as boolean, equality, identity,
* relational or type comparisons with other objects, and so on.
*
* @param the type of Object as the subject of the is operator.
* @param obj the Object that is the subject of the operation.
* @return an instance of the is operator.
* @see org.cp.elements.lang.annotation.DSL
*/
@DSL
public static Is is(final T obj) {
return new IsExpression<>(obj);
}
/**
* The Is interface defines operations to classify a single object based on it's identity, state, type or relationship
* to another object.
*
* @param the type of Object as the subject of the is operator.
* @see org.cp.elements.lang.DslExtension
*/
public interface Is extends DslExtension {
/**
* Determines whether the Class object provided to the is operator is assignable to the Class type parameter.
*
* @param type the Class type used to check for assignment compatibility.
* @return a boolean value indicating if the Class object provided to the is operator is assignable to
* the Class type parameter.
* @see java.lang.Class#isAssignableFrom(Class)
*/
boolean assignableTo(Class type);
/**
* Determines whether the object provided to the is operator is equal to the object parameter. The objects are
* considered equal as determined by their compareTo method. This implies that the objects in the equality
* comparison must implement the Comparable interface.
*
* @param obj the Object parameter used in the equality comparison.
* @return a boolean value indicating whether the objects are equal.
* @see java.lang.Comparable#compareTo(Object)
*/
boolean comparableTo(T obj);
/**
* Determines whether the object provided to the is operator is equal to the object parameter. The objects are
* considered equal when neither is null, both refer to the same object, or both objects have the same value as
* determined by their equals method.
*
* @param obj the Object parameter used in the equality comparison.
* @return a boolean value indicating whether the objects are equal.
* @see java.lang.Object#equals(Object)
*/
boolean equalTo(T obj);
/**
* Shortcut for not().equalTo(:Object). Determines whether the object provided to the is operator is not equal to
* the object parameter. The objects are considered unequal when either is null, both are objects of
* different types, or both objects are unequal in value as determined by their equals method.
*
* @param obj the Object parameter used in the equality comparison.
* @return a boolean value indicating whether the objects are unequal.
* @see #not()
* @see #equalTo(Object)
*/
boolean notEqualTo(T obj);
/**
* Determines whether the object provided to the is operator actually evaluates to the value false. An object
* is false if and only if the value is actually false and not null or some other value (such as true).
*
* @return a boolean value of true if the object in question is indeed the value false.
* @see java.lang.Boolean#FALSE
*/
boolean False();
/**
* Determines whether the object provided to the is operator is greater than the specified value, as determined
* by the Comparable object's compareTo method.
*
* @param lowerBound the lower bound value for which the object must be greater than.
* @return a boolean value indicating if the object is greater than the specified value.
* @see java.lang.Comparable#compareTo(Object)
*/
boolean greaterThan(T lowerBound);
/**
* Determines whether the object provided to the is operator is greater than some specified lower bound value
* and also less than some specified upper bound value, as determined by the Comparable object's compareTo method.
*
* @param lowerBound the lower bound value for which the object must be greater than.
* @param upperBound the upper bound value for which the object must be less than.
* @return a boolean value indicating if the object is greater than the lower bound value and less than the
* upper bound value.
* @see java.lang.Comparable#compareTo(Object)
*/
boolean greaterThanAndLessThan(T lowerBound, T upperBound);
/**
* Determines whether the object provided to the is operator is greater than some specified lower bound value
* and also less than or equal to some specified upper bound value, as determined by the Comparable object's
* compareTo method.
*
* @param lowerBound the lower bound value for which the object must be greater than.
* @param upperBound the upper bound value for which the object must be less than or equal to.
* @return a boolean value indicating if the object is greater than the lower bound value and less than or equal to
* the upper bound value.
* @see java.lang.Comparable#compareTo(Object)
*/
boolean greaterThanAndLessThanEqualTo(T lowerBound, T upperBound);
/**
* Determines whether the object provided to the is operator is greater than or equal to the specified value,
* as determined by the Comparable object's compareTo method.
*
* @param lowerBound the lower bound value for which the object must be greater than or equal to.
* @return a boolean value indicating if the object is greater than or equal to the specified value.
* @see java.lang.Comparable#compareTo(Object)
*/
boolean greaterThanEqualTo(T lowerBound);
/**
* Determines whether the object provided to the is operator is greater than or equal to some specified
* lower bound value and also less than some specified upper bound value, as determined by the Comparable object's
* compareTo method.
*
* @param lowerBound the lower bound value for which the object must be greater than or equal to.
* @param upperBound the upper bound value for which the object must be less than.
* @return a boolean value indicating if the object is greater than or equal to the lower bound value and less than
* the upper bound value.
* @see java.lang.Comparable#compareTo(Object)
*/
boolean greaterThanEqualToAndLessThan(T lowerBound, T upperBound);
/**
* Determines whether the object provided to the is operator is greater than or equal to some specified
* lower bound value and also less than or equal to some specified upper bound value, as determined by
* the Comparable object's compareTo method.
*
* @param lowerBound the lower bound value for which the object must be greater than or equal to.
* @param upperBound the upper bound value for which the object must be less than or equal to.
* @return a boolean value indicating if the object is greater than or equal to the lower bound value
* and less than or equal to the upper bound value.
* @see java.lang.Comparable#compareTo(Object)
*/
boolean greaterThanEqualToAndLessThanEqualTo(T lowerBound, T upperBound);
/**
* Determines whether the object provided to the is operator is an instance of the specified class type.
*
* @param type the Class object used in determining if the object in question is an instance of the
* specified Class.
* @return a boolean value indicating whether the object in question is an instance of the specified Class.
*/
boolean instanceOf(Class type);
/**
* Determines whether the object provided to the is operator is less than the specified value, as determined by
* the Comparable object's compareTo method.
*
* @param upperBound the upper bound value for which the object must be less than.
* @return a boolean value indicating if the object is less than the specified value.
* @see java.lang.Comparable#compareTo(Object)
*/
boolean lessThan(T upperBound);
/**
* Determines whether the object provided to the is operator is less than some specified lower upper bound value
* or greater than some specified upper lower bound value, as determined by the Comparable object's
* compareTo method.
*
* @param upperBound the upper bound value for which the object must be less than.
* @param lowerBound the lower bound value for which the object must be greater than.
* @return a boolean value indicating if the object is less than the upper bound value
* or is greater than the lower bound value.
* @see java.lang.Comparable#compareTo(Object)
*/
boolean lessThanOrGreaterThan(T upperBound, T lowerBound);
/**
* Determines whether the object provided to the is operator is less than some specified lower upper bound value
* or greater than or equal to some specified upper lower bound value, as determined by the Comparable object's
* compareTo method.
*
* @param upperBound the upper bound value for which the object must be less than.
* @param lowerBound the lower bound value for which the object must be greater than or equal to.
* @return a boolean value indicating if the object is less than the upper bound value or is greater than
* or equal to the lower bound value.
* @see java.lang.Comparable#compareTo(Object)
*/
boolean lessThanOrGreaterThanEqualTo(T upperBound, T lowerBound);
/**
* Determines whether the object provided to the is operator is less than or equal to the specified value,
* as determined by the Comparable object's compareTo method.
*
* @param upperBound the upper bound value for which the object must be less than or equal to.
* @return a boolean value indicating if the object is less than or equal to the specified value.
* @see java.lang.Comparable#compareTo(Object)
*/
boolean lessThanEqualTo(T upperBound);
/**
* Determines whether the object provided to the is operator is less than or equal to some specified
* lower upper bound value or greater than some specified upper lower bound value, as determined by
* the Comparable object's compareTo method.
*
* @param upperBound the upper bound value for which the object must be less than or equal to.
* @param lowerBound the lower bound value for which the object must be greater than.
* @return a boolean value indicating if the object is less than or equal to the upper bound value
* or is greater than the lower bound value.
* @see java.lang.Comparable#compareTo(Object)
*/
boolean lessThanEqualToOrGreaterThan(T upperBound, T lowerBound);
/**
* Determines whether the object provided to the is operator is less than or equal to some specified
* lower upper bound value or greater than or equal to some specified upper lower bound value, as determined by
* the Comparable object's compareTo method.
*
* @param upperBound the upper bound value for which the object must be less than or equal to.
* @param lowerBound the lower bound value for which the object must be greater than or equal to.
* @return a boolean value indicating if the object is less than or equal to the upper bound value
* or is greater than or equal to the lower bound value.
* @see java.lang.Comparable#compareTo(Object)
*/
boolean lessThanEqualToOrGreaterThanEqualTo(T upperBound, T lowerBound);
/**
* Determines whether the String object provided to the is operator is not blank (or rather, has actual text data).
*
* @return a boolean value indicating whether the String has actual text data.
*/
boolean notBlank();
/**
* Determines whether the String object provided to the is operator is not empty.
*
* @return a boolean value indicating whether the String is not empty.
*/
boolean notEmpty();
/**
* Shortcut method for the not().Null() operation. Determines whether the object provided to the is operator
* is not null.
*
* @return a boolean value indicating whether the object in question is not null.
* @see #not()
* @see #Null()
*/
boolean notNull();
/**
* Determines whether the object provided to the is operator is null.
*
* @return a boolean value indicating whether the object in question is null.
*/
boolean Null();
/**
* Determines whether the object provided to the is operator is the same as, or refers to the same object
* in memory as the given object parameter.
*
* @param obj the Object reference used to determine if the object in question is a reference to the same object
* in memory.
* @return a boolean value indicating whether the object in question and object parameter reference refers to
* the same object.
*/
boolean sameAs(T obj);
/**
* Shortcut for not().isSameAs(:Object). Determines whether the object provided to the is operator is *not*
* the same as, or does not refer to the same object in memory as the given object parameter.
*
* @param obj the Object reference used to determine if the object in question is not a reference to the same object
* in memory.
* @return a boolean value indicating whether the object in question and object parameter do not refer to
* the same object.
* @see #not()
* @see #sameAs(Object)
*/
boolean notSameAs(T obj);
/**
* Determines whether the object provided to the is operator actually evaluates to the value true. An object
* is true if and only if the value is actually true and not null or some other value (such as false).
*
* @return a boolean value of true if the object in question is indeed the value true
* @see java.lang.Boolean#TRUE
*/
boolean True();
/**
* Negates the expected outcome/result of this operator.
*
* @return the instance of this Is operator negated.
*/
Is not();
}
/**
* The IsExpression class is an implementation of the Is interface, is operator. Note, this implementation is Thread-safe,
* although it is very unlikely that a Thread will share an instance of this class since every invocation of the
* is() operator factory method will return a new instance of this class, at least for the time being.
*
* @param the Object's type.
* @see org.cp.elements.lang.LangExtensions.Is
*/
private static final class IsExpression implements Is {
private static final boolean DEFAULT_EXPECTED = true;
private final boolean expected;
private final T obj;
/* (non-Javadoc) */
private IsExpression(final T obj) {
this(obj, DEFAULT_EXPECTED);
}
/* (non-Javadoc) */
private IsExpression(final T obj, final boolean expected) {
this.obj = obj;
this.expected = expected;
}
/* (non-Javadoc) */
private boolean equalToExpected(final boolean actualOutcome) {
return (actualOutcome == expected);
}
/* (non-Javadoc) */
private LogicalOperator getOp(final LogicalOperator op) {
return (expected ? op : op.getOpposite());
}
/* (non-Javadoc) */
private Class toClass(final Object obj) {
return (obj instanceof Class ? (Class) obj : obj.getClass());
}
/* (non-Javadoc) */
@SuppressWarnings("unchecked")
private Comparable toComparable(final T obj) {
return (Comparable) obj;
}
/* (non-Javadoc) */
public boolean assignableTo(final Class type) {
return equalToExpected(obj != null && type != null && type.isAssignableFrom(toClass(obj)));
}
/* (non-Javadoc) */
public boolean comparableTo(final T obj) {
return equalToExpected(toComparable(this.obj).compareTo(obj) == 0);
}
/* (non-Javadoc) */
public boolean equalTo(final T obj) {
return equalToExpected(this.obj != null && this.obj.equals(obj));
}
/* (non-Javadoc) */
public boolean notEqualTo(final T obj) {
return not().equalTo(obj);
}
/* (non-Javadoc) */
public boolean False() {
return equalToExpected(Boolean.FALSE.equals(this.obj));
}
/* (non-Javadoc) */
public boolean greaterThan(final T lowerBound) {
return equalToExpected(toComparable(this.obj).compareTo(lowerBound) > 0);
}
/* (non-Javadoc) */
public boolean greaterThanAndLessThan(final T lowerBound, final T upperBound) {
return getOp(LogicalOperator.AND).evaluate(greaterThan(lowerBound), lessThan(upperBound));
}
/* (non-Javadoc) */
public boolean greaterThanAndLessThanEqualTo(final T lowerBound, final T upperBound) {
return getOp(LogicalOperator.AND).evaluate(greaterThan(lowerBound), lessThanEqualTo(upperBound));
}
/* (non-Javadoc) */
public boolean greaterThanEqualTo(final T lowerBound) {
return equalToExpected(toComparable(this.obj).compareTo(lowerBound) >= 0);
}
/* (non-Javadoc) */
public boolean greaterThanEqualToAndLessThan(final T lowerBound, final T upperBound) {
return getOp(LogicalOperator.AND).evaluate(greaterThanEqualTo(lowerBound), lessThan(upperBound));
}
/* (non-Javadoc) */
public boolean greaterThanEqualToAndLessThanEqualTo(final T lowerBound, final T upperBound) {
return getOp(LogicalOperator.AND).evaluate(greaterThanEqualTo(lowerBound), lessThanEqualTo(upperBound));
}
/* (non-Javadoc) */
public boolean instanceOf(final Class type) {
return equalToExpected(type != null && type.isInstance(this.obj));
}
/* (non-Javadoc) */
public boolean lessThan(final T upperBound) {
return equalToExpected(toComparable(this.obj).compareTo(upperBound) < 0);
}
/* (non-Javadoc) */
public boolean lessThanOrGreaterThan(final T upperBound, final T lowerBound) {
return getOp(LogicalOperator.OR).evaluate(lessThan(upperBound), greaterThan(lowerBound));
}
/* (non-Javadoc) */
public boolean lessThanOrGreaterThanEqualTo(final T upperBound, final T lowerBound) {
return getOp(LogicalOperator.OR).evaluate(lessThan(upperBound), greaterThanEqualTo(lowerBound));
}
/* (non-Javadoc) */
public boolean lessThanEqualTo(final T upperBound) {
return equalToExpected(toComparable(this.obj).compareTo(upperBound) <= 0);
}
/* (non-Javadoc) */
public boolean lessThanEqualToOrGreaterThan(final T upperBound, final T lowerBound) {
return getOp(LogicalOperator.OR).evaluate(lessThanEqualTo(upperBound), greaterThan(lowerBound));
}
/* (non-Javadoc) */
public boolean lessThanEqualToOrGreaterThanEqualTo(final T upperBound, final T lowerBound) {
return getOp(LogicalOperator.OR).evaluate(lessThanEqualTo(upperBound), greaterThanEqualTo(lowerBound));
}
/* (non-Javadoc) */
public boolean notBlank() {
return StringUtils.hasText(ObjectUtils.toString(obj));
}
/* (non-Javadoc) */
public boolean notEmpty() {
boolean result = (obj instanceof Object[] && ((Object[]) obj).length != 0);
result |= (obj instanceof Collection && !((Collection) obj).isEmpty());
result |= (obj instanceof Map && !((Map) obj).isEmpty());
result |= (obj instanceof String && !obj.toString().isEmpty());
return result;
}
/* (non-Javadoc) */
public boolean notNull() {
return not().Null();
}
/* (non-Javadoc) */
public boolean Null() {
return equalToExpected(this.obj == null);
}
/* (non-Javadoc) */
public boolean notSameAs(final T obj) {
return not().sameAs(obj);
}
/* (non-Javadoc) */
public boolean sameAs(final T obj) {
return equalToExpected(this.obj == obj);
}
/* (non-Javadoc) */
public boolean True() {
return equalToExpected(Boolean.TRUE.equals(this.obj));
}
/* (non-Javadoc) */
public Is not() {
return new IsExpression<>(this.obj, !expected);
}
}
}