org.opentest4j

Class ValueWrapper

java.lang.Object

org.opentest4j.ValueWrapper

All Implemented Interfaces:

Serializable

public final class ValueWrapper
extends Object
implements Serializable

Serializable representation of a value that was used in an assertion.

This class only stores the value if it implements Serializable. In any case, it stores its runtime type, identity hash code, and string representation determined via String.valueOf(Object). If the invocation of String.valueOf(Object) throws an Exception, the string representation will take the form of "<Exception in toString(): " + e + ">", where "e" is the caught exception.

The toString() method returns the string representation of the value along with its type and identity hash code.

Since:

1.0

Author:

Marc Philipp, Sam Brannen

See Also:

System.identityHashCode(java.lang.Object), Serialized Form

Method Summary

Modifier and Type	Method and Description
static ValueWrapper	create(Object value) Factory for creating a new ValueWrapper for the supplied value.
static ValueWrapper	create(Object value, String stringRepresentation) Factory for creating a new ValueWrapper for the supplied value using the supplied custom stringRepresentation.
Object	getEphemeralValue() Returns the original value supplied to create().
int	getIdentityHashCode() Returns the value's identity hash code.
String	getStringRepresentation() Returns the value's string representation.
Class<?>	getType() Returns the value's runtime type or null if the value is null.
Serializable	getValue() Returns the value supplied to create(Object) if the value implements Serializable; otherwise, null.
String	toString() Returns the value's string representation along with its type and identity hash code.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ValueWrapper create(Object value)

Factory for creating a new ValueWrapper for the supplied value.

If the supplied value is null, this method will return a cached ValueWrapper suitable for all null values. If the supplied value is already an instance of ValueWrapper, it will be returned as is.

Parameters:

value - the value to wrap; may be null

Returns:

a wrapper for the supplied value; never null

create

public static ValueWrapper create(Object value,
                                  String stringRepresentation)

Factory for creating a new ValueWrapper for the supplied value using the supplied custom stringRepresentation.

You should use this method when you don't want to rely on the result of the value's toString() method.

If the supplied value is null, this method will return a cached ValueWrapper suitable for all null values. If the supplied value is already an instance of ValueWrapper, it will be returned as is if the stringRepresentation match, otherwise the original value will be unwrapped and a new ValueWrapper with the new stringRepresentation will be created.

Parameters:

value - the value to wrap; may be null

stringRepresentation - a custom rendering of the value; will fallback to the default behavior if null

Returns:

a wrapper for the supplied value; never null

Since:

1.2

getValue

public Serializable getValue()

Returns the value supplied to create(Object) if the value implements Serializable; otherwise, null.

See Also:

getEphemeralValue()

getType

public Class<?> getType()

Returns the value's runtime type or null if the value is null.

getStringRepresentation

public String getStringRepresentation()

Returns the value's string representation.

The string representation is generated by invoking String.valueOf(value) for the value supplied to create(Object).

See Also:

getValue()

getIdentityHashCode

public int getIdentityHashCode()

Returns the value's identity hash code.

The identity hash code is generated by invoking System.identityHashCode(value) for the value supplied to create(Object).

See Also:

getValue()

getEphemeralValue

public Object getEphemeralValue()

Returns the original value supplied to create().

If this ValueWrapper was created by deserialization this method returns null.

Since:

1.2

See Also:

getValue()

toString

public String toString()

Returns the value's string representation along with its type and identity hash code.

Overrides:

toString in class Object