Package org.apache.juneau.assertions

Class FluentByteArrayAssertion<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.FluentPrimitiveArrayAssertion<Byte,byte[],R>

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

Type Parameters:

R - The return type.

Direct Known Subclasses:

ByteArrayAssertion

public class FluentByteArrayAssertion<R>
extends FluentPrimitiveArrayAssertion<Byte,byte[],R>

Used for fluent assertion calls against byte arrays.

Test Methods:

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

• FluentByteArrayAssertion
  • asString()
  • asString(Charset)
  • asBase64()
  • asHex()
  • asSpacedHex()
• FluentPrimitiveArrayAssertion
  • asItem(int)
  • asLength()
• 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
FluentByteArrayAssertion(byte[] value, R returns)	Constructor.
FluentByteArrayAssertion(Assertion creator, byte[] value, R returns)	Chained constructor.

Method Summary

Modifier and Type	Method	Description
FluentStringAssertion<R>	asBase64()	Converts this byte array to a base-64 encoded string and returns it as a new assertion.
FluentStringAssertion<R>	asHex()	Converts this byte array to hexadecimal and returns it as a new assertion.
FluentStringAssertion<R>	asSpacedHex()	Converts this byte array to spaced hexadecimal and returns it as a new assertion.
FluentStringAssertion<R>	asString()	Converts this byte array to a UTF-8 encoded string and returns it as a new assertion.
FluentStringAssertion<R>	asString(Charset cs)	Converts this byte array to a string and returns it as a new assertion.
FluentByteArrayAssertion<R>	setMsg(String msg, Object... args)	Allows you to override the assertion failure message.
FluentByteArrayAssertion<R>	setOut(PrintStream value)	If an error occurs, send the error message to the specified stream instead of STDERR.
FluentByteArrayAssertion<R>	setSilent()	Suppresses output to STDERR.
FluentByteArrayAssertion<R>	setStdOut()	If an error occurs, send the error message to STDOUT instead of STDERR.
FluentByteArrayAssertion<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.FluentPrimitiveArrayAssertion

asItem, asLength, asTransformed, is, isAll, isAny, isContains, isEmpty, isHas, isNotContains, isNotEmpty, isSize, toString

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

asAny, asJson, asJsonSorted, asString, asString, asTransformedTo, equals, getFailureMessage, is, is, isAny, isExactType, isExists, isJson, isNot, isNotAny, isNotNull, isNull, isSame, isSameJsonAs, isSameSerializedAs, isSameSortedJsonAs, isString, isType, map, opt, orElse, 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

FluentByteArrayAssertion

public FluentByteArrayAssertion(byte[] 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.

FluentByteArrayAssertion

public FluentByteArrayAssertion(Assertion creator,
 byte[] 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

asString

public FluentStringAssertion<R> asString()

Converts this byte array to a UTF-8 encoded string and returns it as a new assertion.

Example:

// Validates that the specified byte array contains the string "foobar". assertBytes(myByteArray).asString().is("foobar");

Overrides:

asString in class FluentPrimitiveArrayAssertion<Byte,byte[],R>

Returns:

A new fluent string assertion.

asString

public FluentStringAssertion<R> asString(Charset cs)

Converts this byte array to a string and returns it as a new assertion.

Example:

// Validates that the specified byte array contains the string "foobar" encoded in ASCII. assertBytes(myByteArray).asString("iso8859-1").is("foobar");

Parameters:

cs - The charset to use to decode the string.

Returns:

A new fluent string assertion.

asBase64

public FluentStringAssertion<R> asBase64()

Converts this byte array to a base-64 encoded string and returns it as a new assertion.

Example:

// Validates that the specified byte array contains the string "foo". assertBytes(myByteArray).asBase64().is("Zm9v");

Returns:

A new fluent string assertion.

asHex

public FluentStringAssertion<R> asHex()

Converts this byte array to hexadecimal and returns it as a new assertion.

Example:

// Validates that the specified byte array contains the string "foo". assertBytes(myByteArray).asHex().is("666F6F");

Returns:

A new string consisting of hexadecimal characters.

asSpacedHex

public FluentStringAssertion<R> asSpacedHex()

Converts this byte array to spaced hexadecimal and returns it as a new assertion.

Example:

// Validates that the specified byte array contains the string "foo". assertBytes(myByteArray).asSpacedHex().is("66 6F 6F");

Returns:

A new string consisting of hexadecimal characters.

setMsg

public FluentByteArrayAssertion<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 FluentPrimitiveArrayAssertion<Byte,byte[],R>

Parameters:

msg - The assertion failure message.

args - Optional message arguments.

Returns:

This object.

setOut

public FluentByteArrayAssertion<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 FluentPrimitiveArrayAssertion<Byte,byte[],R>

Parameters:

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

Returns:

This object.

setSilent

public FluentByteArrayAssertion<R> setSilent()

Description copied from class: Assertion

Suppresses output to STDERR.

This is the equivalent to calling out(null).

Overrides:

setSilent in class FluentPrimitiveArrayAssertion<Byte,byte[],R>

Returns:

This object.

setStdOut

public FluentByteArrayAssertion<R> setStdOut()

Description copied from class: Assertion

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

Overrides:

setStdOut in class FluentPrimitiveArrayAssertion<Byte,byte[],R>

Returns:

This object.

setThrowable

public FluentByteArrayAssertion<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 FluentPrimitiveArrayAssertion<Byte,byte[],R>

Parameters:

value - The new value for this setting.

Returns:

This object.