Package org.apache.juneau.assertions

Class StringListAssertion

java.lang.Object

org.apache.juneau.assertions.Assertion

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

org.apache.juneau.assertions.FluentObjectAssertion<Collection<E>,R>

org.apache.juneau.assertions.FluentCollectionAssertion<E,R>

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

org.apache.juneau.assertions.FluentStringListAssertion<StringListAssertion>

org.apache.juneau.assertions.StringListAssertion

public class StringListAssertion
extends FluentStringListAssertion<StringListAssertion>

Used for assertion calls against lists of strings.

Test Methods:

• FluentListAssertion
  • isHas(Object...)
  • isEach(Predicate...)
• FluentCollectionAssertion
  • isEmpty()
  • isNotEmpty()
  • isContains(Object)
  • isNotContains(Object)
  • isAny(Predicate)
  • isAll(Predicate)
  • isSize(int size)
• 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:

• FluentStringListAssertion
  • asJoin()
  • asJoin(String)
  • asJoin(String,String,String)
  • asTrimmed()
• FluentListAssertion
  • asStrings()
  • asStrings(Function)
  • asCdl()
  • asCdl(Function)
  • asItem(int)
  • asSorted()
  • asSorted(Comparator)
• FluentCollectionAssertion
  • asStrings()
  • asSize()
• 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:

• Overview > juneau-assertions > Overview

Constructor Summary

Constructors

Constructor	Description
StringListAssertion(List<String> value)	Constructor.

Method Summary

Modifier and Type	Method	Description
static StringListAssertion	create(List<String> value)	Static creator.
StringListAssertion	setMsg(String msg, Object... args)	Allows you to override the assertion failure message.
StringListAssertion	setOut(PrintStream value)	If an error occurs, send the error message to the specified stream instead of STDERR.
StringListAssertion	setSilent()	Suppresses output to STDERR.
StringListAssertion	setStdOut()	If an error occurs, send the error message to STDOUT instead of STDERR.
StringListAssertion	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.FluentStringListAssertion

asJoin, asJoin, asJoin, asTrimmed

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

asApplied2, asCdl, asCdl, asFirst, asFirst, asItem, asLast, asLast, asSorted, asSorted, asStrings, asSublist, isEach, isHas, value

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

asSize, asStrings, asTransformed, getSize, isAll, isAny, isContains, isEmpty, isNotContains, isNotEmpty, isSize

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, 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

StringListAssertion

public StringListAssertion(List<String> value)

Constructor.

Parameters:

value - The object being tested.
Can be null.

Method Details

create

public static StringListAssertion create(List<String> value)

Static creator.

Parameters:

value - The object being tested.
Can be null.

Returns:

A new assertion object.

setMsg

public StringListAssertion 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 FluentStringListAssertion<StringListAssertion>

Parameters:

msg - The assertion failure message.

args - Optional message arguments.

Returns:

This object.

setOut

public StringListAssertion 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 FluentStringListAssertion<StringListAssertion>

Parameters:

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

Returns:

This object.

setSilent

public StringListAssertion setSilent()

Description copied from class: Assertion

Suppresses output to STDERR.

This is the equivalent to calling out(null).

Overrides:

setSilent in class FluentStringListAssertion<StringListAssertion>

Returns:

This object.

setStdOut

public StringListAssertion setStdOut()

Description copied from class: Assertion

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

Overrides:

setStdOut in class FluentStringListAssertion<StringListAssertion>

Returns:

This object.

setThrowable

public StringListAssertion 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 FluentStringListAssertion<StringListAssertion>

Parameters:

value - The new value for this setting.

Returns:

This object.