Package org.apache.juneau.assertions

Class FluentDateAssertion<R>

java.lang.Object

org.apache.juneau.assertions.Assertion

org.apache.juneau.assertions.FluentAssertion<R>

org.apache.juneau.assertions.FluentObjectAssertion<T,R>

org.apache.juneau.assertions.FluentComparableAssertion<Date,R>

org.apache.juneau.assertions.FluentDateAssertion<R>

Type Parameters:

R - The return type.

Direct Known Subclasses:

DateAssertion

public class FluentDateAssertion<R>
extends FluentComparableAssertion<Date,R>

Used for fluent assertion calls against dates.

Example:

// Validates the response expiration is after the current date. client .get(URL) .run() .assertDateHeader("Expires").isAfterNow();

Test Methods:

• FluentDateAssertion
  • is(Date,ChronoUnit)
  • isAfter(Date)
  • isAfterNow()
  • isBefore(Date)
  • isBeforeNow()
  • isBetween(Date,Date)
• FluentComparableAssertion
  • isGt(Comparable)
  • isGte(Comparable)
  • isLt(Comparable)
  • isLte(Comparable)
  • isBetween(Comparable,Comparable)
• FluentObjectAssertion
  • isExists()
  • is(Object)
  • is(Predicate)
  • isNot(Object)
  • isAny(Object...)
  • isNotAny(Object...)
  • isNull()
  • isNotNull()
  • isString(String)
  • isJson(String)
  • isSame(Object)
  • isSameJsonAs(Object)
  • isSameSortedJsonAs(Object)
  • isSameSerializedAs(Object, WriterSerializer)
  • isType(Class)
  • isExactType(Class)

Transform Methods:

• FluentDateAssertion
  • asEpochMillis()
  • asEpochSeconds()
• FluentObjectAssertion
  • asString()
  • asString(WriterSerializer)
  • asString(Function)
  • asJson()
  • asJsonSorted()
  • asApplied(Function)
  • asAny()

Configuration Methods:

• Assertion
  • setMsg(String, Object...)
  • setOut(PrintStream)
  • setSilent()
  • setStdOut()
  • setThrowable(Class)

See Also:

• Juneau Ecosystem Overview

Constructor Summary

Constructors

Constructor	Description
FluentDateAssertion(Date value, R returns)	Constructor.
FluentDateAssertion(Assertion creator, Date value, R returns)	Chained constructor.

Method Summary

Modifier and Type	Method	Description
FluentLongAssertion<R>	asEpochMillis()	Returns an long assertion on the epoch milliseconds of this date.
FluentLongAssertion<R>	asEpochSeconds()	Returns an long assertion on the epoch seconds of this date.
R	is(Date value, ChronoUnit precision)	Asserts that the value equals the specified value at the specified precision.
R	isAfter(Date value)	Asserts that the value is after the specified value.
R	isAfterNow()	Asserts that the value is after the current date.
R	isBefore(Date value)	Asserts that the value is before the specified value.
R	isBeforeNow()	Asserts that the value is before the current date.
R	isBetween(Date lower, Date upper)	Asserts that the value is between (inclusive) the specified upper and lower values.
FluentDateAssertion<R>	setMsg(String msg, Object... args)	Allows you to override the assertion failure message.
FluentDateAssertion<R>	setOut(PrintStream value)	If an error occurs, send the error message to the specified stream instead of STDERR.
FluentDateAssertion<R>	setSilent()	Suppresses output to STDERR.
FluentDateAssertion<R>	setStdOut()	If an error occurs, send the error message to STDOUT instead of STDERR.
FluentDateAssertion<R>	setThrowable(Class<? extends RuntimeException> value)	If an error occurs, throw this exception instead of the standard AssertionError.

Methods inherited from class org.apache.juneau.assertions.FluentComparableAssertion

asTransformed, isBetween, isGt, isGte, isLt, isLte

Methods inherited from class org.apache.juneau.assertions.FluentObjectAssertion

asAny, asJson, asJsonSorted, asString, asString, asString, asTransformedTo, equals, getFailureMessage, is, is, isAny, isExactType, isExists, isJson, isNot, isNotAny, isNotNull, isNull, isSame, isSameJsonAs, isSameSerializedAs, isSameSortedJsonAs, isString, isType, map, opt, orElse, toString, value, valueAsString, valueIsNotNull, valueIsNull

Methods inherited from class org.apache.juneau.assertions.FluentAssertion

returns

Methods inherited from class org.apache.juneau.assertions.Assertion

arrayClass, className, error, error

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

FluentDateAssertion

public FluentDateAssertion(Date value,
 R returns)

Constructor.

Parameters:

value - The object being tested.
Can be null.

returns - The object to return after a test method is called.
If null, the test method returns this object allowing multiple test method calls to be used on the same assertion.

FluentDateAssertion

public FluentDateAssertion(Assertion creator,
 Date value,
 R returns)

Chained constructor.

Used when transforming one assertion into another so that the assertion config can be used by the new assertion.

Parameters:

creator - The assertion that created this assertion.
Should be null if this is the top-level assertion.

value - The object being tested.
Can be null.

returns - The object to return after a test method is called.
If null, the test method returns this object allowing multiple test method calls to be used on the same assertion.

Method Details

asEpochMillis

public FluentLongAssertion<R> asEpochMillis()

Returns an long assertion on the epoch milliseconds of this date.

If the date is null, the returned assertion is a null assertion (meaning FluentObjectAssertion.isExists() returns false).

Returns:

A new assertion.

asEpochSeconds

public FluentLongAssertion<R> asEpochSeconds()

Returns an long assertion on the epoch seconds of this date.

If the date is null, the returned assertion is a null assertion (meaning FluentObjectAssertion.isExists() returns false).

Returns:

A new assertion.

is

public R is(Date value,
 ChronoUnit precision)
     throws AssertionError

Asserts that the value equals the specified value at the specified precision.

Parameters:

value - The value to check against.

precision - The precision (e.g. ChronoUnit.SECONDS).

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed.

isAfter

public R isAfter(Date value)
          throws AssertionError

Asserts that the value is after the specified value.

Parameters:

value - The values to check against.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed.

isAfterNow

public R isAfterNow()
             throws AssertionError

Asserts that the value is after the current date.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed.

isBefore

public R isBefore(Date value)
           throws AssertionError

Asserts that the value is before the specified value.

Parameters:

value - The values to check against.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed.

isBeforeNow

public R isBeforeNow()
              throws AssertionError

Asserts that the value is before the current date.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed.

isBetween

public R isBetween(Date lower,
 Date upper)
            throws AssertionError

Asserts that the value is between (inclusive) the specified upper and lower values.

Parameters:

lower - The lower value to check against.

upper - The upper value to check against.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed.

setMsg

public FluentDateAssertion<R> setMsg(String msg,
 Object... args)

Description copied from class: Assertion

Allows you to override the assertion failure message.

String can contain "{msg}" to represent the original message.

Example:

import static org.apache.juneau.assertions.Assertions.*; // Throws an assertion with a custom message instead of the default "Value was null." assertString(myString) .setMsg("My string was bad: {msg}") .isNotNull();

Overrides:

setMsg in class FluentComparableAssertion<Date,R>

Parameters:

msg - The assertion failure message.

args - Optional message arguments.

Returns:

This object.

setOut

public FluentDateAssertion<R> setOut(PrintStream value)

Description copied from class: Assertion

If an error occurs, send the error message to the specified stream instead of STDERR.

Overrides:

setOut in class FluentComparableAssertion<Date,R>

Parameters:

value - The output stream. Can be null to suppress output.

Returns:

This object.

setSilent

public FluentDateAssertion<R> setSilent()

Description copied from class: Assertion

Suppresses output to STDERR.

This is the equivalent to calling out(null).

Overrides:

setSilent in class FluentComparableAssertion<Date,R>

Returns:

This object.

setStdOut

public FluentDateAssertion<R> setStdOut()

Description copied from class: Assertion

If an error occurs, send the error message to STDOUT instead of STDERR.

Overrides:

setStdOut in class FluentComparableAssertion<Date,R>

Returns:

This object.

setThrowable

public FluentDateAssertion<R> setThrowable(Class<? extends RuntimeException> value)

Description copied from class: Assertion

If an error occurs, throw this exception instead of the standard AssertionError.

The throwable class must have a public constructor that takes in any of the following parameters:

• Throwable - The caused-by exception (if there is one).
• String - The assertion failure message.

If the throwable cannot be instantiated, a RuntimeException is thrown instead.

Example:

import static org.apache.juneau.assertions.Assertions.*; // Throws a BadRequest instead of an AssertionError if the string is null. assertString(myString) .setThrowable(BadRequest.class) .isNotNull();

Overrides:

setThrowable in class FluentComparableAssertion<Date,R>

Parameters:

value - The new value for this setting.

Returns:

This object.