Package org.apache.juneau.rest.assertions

Class FluentRequestFormParamAssertion<R>

java.lang.Object

org.apache.juneau.assertions.Assertion

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

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

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

org.apache.juneau.rest.assertions.FluentRequestFormParamAssertion<R>

Type Parameters:

R - The return type.

public class FluentRequestFormParamAssertion<R>
extends FluentStringAssertion<R>

Used for fluent assertion calls against RequestFormParam objects.

Test Methods

• FluentStringAssertion
  • is(String)
  • isNot(String)
  • isLines(String...)
  • isSortedLines(String...)
  • isIc(String)
  • isNotIc(String)
  • isContains(String...)
  • isNotContains(String...)
  • isEmpty()
  • isNotEmpty()
  • isString(Object)
  • isMatches(String)
  • isPattern(String)
  • isPattern(String,int)
  • isPattern(Pattern)
  • isStartsWith(String)
  • isEndsWith(String)
• 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

• FluentRequestFormParamAssertion
  • asBoolean()
  • asInteger()
  • asLong()
  • asZonedDateTime()
  • as(Class)
  • as(Type,Type...)
• FluentStringAssertion
  • asReplaceAll(String,String)
  • asReplace(String,String)
  • asUrlDecode()
  • asLc()
  • asUc()
  • asLines()
  • asSplit(String)
  • asLength()
  • asOneLine()
• 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
FluentRequestFormParamAssertion(Assertion creator, RequestFormParam value, R returns)	Chained constructor.
FluentRequestFormParamAssertion(RequestFormParam value, R returns)	Constructor.

Method Summary

Modifier and Type	Method	Description
<T> FluentAnyAssertion<T,R>	as(Class<T> type)	Converts the parameter value to a type using RequestHttpPart.as(Class) and then returns the value as an any-object assertion.
FluentAnyAssertion<Object,R>	as(Type type, Type... args)	Converts the parameter value to a type using RequestHttpPart.as(Type,Type...) and then returns the value as an any-object assertion.
FluentBooleanAssertion<R>	asBoolean()	Converts this object assertion into a boolean assertion.
FluentIntegerAssertion<R>	asInteger()	Converts this object assertion into an integer assertion.
FluentRequestFormParamAssertion<R>	asJavaStrings()	When enabled, text in the message is converted to valid Java strings.
FluentLongAssertion<R>	asLong()	Converts this object assertion into a long assertion.
FluentZonedDateTimeAssertion<R>	asZonedDateTime()	Converts this object assertion into a zoned-datetime assertion.
FluentRequestFormParamAssertion<R>	setMsg(String msg, Object... args)	Allows you to override the assertion failure message.
FluentRequestFormParamAssertion<R>	setOut(PrintStream value)	If an error occurs, send the error message to the specified stream instead of STDERR.
FluentRequestFormParamAssertion<R>	setSilent()	Suppresses output to STDERR.
FluentRequestFormParamAssertion<R>	setStdOut()	If an error occurs, send the error message to STDOUT instead of STDERR.
FluentRequestFormParamAssertion<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.FluentStringAssertion

asLc, asLength, asLines, asOneLine, asReplace, asReplaceAll, asSplit, asTransformed, asTrimmed, asUc, asUrlDecode, is, isContains, isEmpty, isEndsWith, isIc, isLines, isMatches, isNot, isNotContains, isNotEmpty, isNotIc, isPattern, isPattern, isPattern, isSortedLines, isStartsWith, isString

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

asAny, asJson, asJsonSorted, asString, asString, asString, asTransformedTo, equals, getFailureMessage, is, isAny, isExactType, isExists, isJson, 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

FluentRequestFormParamAssertion

public FluentRequestFormParamAssertion(RequestFormParam 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.

FluentRequestFormParamAssertion

public FluentRequestFormParamAssertion(Assertion creator,
 RequestFormParam 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

asBoolean

public FluentBooleanAssertion<R> asBoolean()

Converts this object assertion into a boolean assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not a boolean.

asInteger

public FluentIntegerAssertion<R> asInteger()

Converts this object assertion into an integer assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not an integer.

asLong

public FluentLongAssertion<R> asLong()

Converts this object assertion into a long assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not a long.

asZonedDateTime

public FluentZonedDateTimeAssertion<R> asZonedDateTime()

Converts this object assertion into a zoned-datetime assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not a zoned-datetime.

as

public <T> FluentAnyAssertion<T,R> as(Class<T> type)

Converts the parameter value to a type using RequestHttpPart.as(Class) and then returns the value as an any-object assertion.

Type Parameters:

T - The object type to create.

Parameters:

type - The object type to create.

Returns:

A new fluent assertion object.

as

public FluentAnyAssertion<Object,R> as(Type type,
 Type... args)

Converts the parameter value to a type using RequestHttpPart.as(Type,Type...) and then returns the value as an any-object assertion.

See Complex Data Types for information on defining complex generic types of Maps and Collections.

Parameters:

type - The object type to create.

args - Optional type arguments.

Returns:

A new fluent assertion object.

setMsg

public FluentRequestFormParamAssertion<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 FluentStringAssertion<R>

Parameters:

msg - The assertion failure message.

args - Optional message arguments.

Returns:

This object.

setOut

public FluentRequestFormParamAssertion<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 FluentStringAssertion<R>

Parameters:

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

Returns:

This object.

setSilent

public FluentRequestFormParamAssertion<R> setSilent()

Description copied from class: Assertion

Suppresses output to STDERR.

This is the equivalent to calling out(null).

Overrides:

setSilent in class FluentStringAssertion<R>

Returns:

This object.

setStdOut

public FluentRequestFormParamAssertion<R> setStdOut()

Description copied from class: Assertion

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

Overrides:

setStdOut in class FluentStringAssertion<R>

Returns:

This object.

setThrowable

public FluentRequestFormParamAssertion<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 FluentStringAssertion<R>

Parameters:

value - The new value for this setting.

Returns:

This object.

asJavaStrings

public FluentRequestFormParamAssertion<R> asJavaStrings()

Description copied from class: FluentStringAssertion

When enabled, text in the message is converted to valid Java strings.

value.replaceAll("\\\\", "\\\\\\\\").replaceAll("\n", "\\\\n").replaceAll("\t", "\\\\t");

Overrides:

asJavaStrings in class FluentStringAssertion<R>

Returns:

This object.