Package org.apache.juneau.bct.assertions

Class StringAssertion

java.lang.Object

org.apache.juneau.bct.assertions.Assertion

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

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

org.apache.juneau.bct.assertions.FluentStringAssertion<StringAssertion>

org.apache.juneau.bct.assertions.StringAssertion

public class StringAssertion
extends FluentStringAssertion<StringAssertion>

Used for assertion calls against string objects.

Example:

// Validates the response body of an HTTP call is the text "OK". assertString(httpBody).is("OK");

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)
  • isSame(Object)
  • isType(Class)
  • isExactType(Class)

Transform Methods:

• FluentStringAssertion
  • asReplaceAll(String,String)
  • asReplace(String,String)
  • asUrlDecode()
  • asLc()
  • asUc()
  • asLines()
  • asSplit(String)
  • asLength()
  • asOneLine()
• FluentObjectAssertion
  • asString()
  • asString(ThrowingFunction)
  • asTransformed(UnaryOperator)
  • asAny()

Configuration Methods:

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

See Also:

• Juneau Ecosystem

Constructor Summary

Constructors

Constructor	Description
StringAssertion(Object value)	Constructor.

Method Summary

Modifier and Type	Method	Description
StringAssertion	asJavaStrings()	When enabled, text in the message is converted to valid Java strings.
static StringAssertion	create(Object value)	Static creator.
StringAssertion	setMsg(String msg, Object... args)	Allows you to override the assertion failure message.
StringAssertion	setOut(PrintStream value)	If an error occurs, send the error message to the specified stream instead of STDERR.
StringAssertion	setSilent()	Suppresses output to STDERR.
StringAssertion	setStdOut()	If an error occurs, send the error message to STDOUT instead of STDERR.
StringAssertion	setThrowable(Class<? extends RuntimeException> value)	If an error occurs, throw this exception instead of the standard AssertionError.

Methods inherited from class org.apache.juneau.bct.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.bct.assertions.FluentObjectAssertion

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

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

returns

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

arrayClass, error, error

Methods inherited from class java.lang.Object

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

Constructor Details

StringAssertion

public StringAssertion(Object value)

Constructor.

Parameters:

value - The object being tested.
Can be null (assertions such as isNull() then operate on the absence of a value).

Method Details

create

public static StringAssertion create(Object value)

Static creator.

Parameters:

value - The object being tested.
Can be null (assertions such as isNull() then operate on the absence of a value).

Returns:

A new assertion object.

asJavaStrings

public StringAssertion 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<StringAssertion>

Returns:

This object.

setMsg

public StringAssertion 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.bct.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<StringAssertion>

Parameters:

msg - The assertion failure message.

args - Optional message arguments.

Returns:

This object.

setOut

public StringAssertion 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<StringAssertion>

Parameters:

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

Returns:

This object.

setSilent

public StringAssertion setSilent()

Description copied from class: Assertion

Suppresses output to STDERR.

This is the equivalent to calling out(null).

Overrides:

setSilent in class FluentStringAssertion<StringAssertion>

Returns:

This object.

setStdOut

public StringAssertion setStdOut()

Description copied from class: Assertion

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

Overrides:

setStdOut in class FluentStringAssertion<StringAssertion>

Returns:

This object.

setThrowable

public StringAssertion 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.bct.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<StringAssertion>

Parameters:

value - The new value for this setting.

Returns:

This object.