org.assertj.core.presentation

Class StandardRepresentation

java.lang.Object

org.assertj.core.presentation.StandardRepresentation

All Implemented Interfaces:

Representation

Direct Known Subclasses:

BinaryRepresentation, HexadecimalRepresentation, UnicodeRepresentation

public class StandardRepresentation
extends Object
implements Representation

Standard java object representation.

Author:

Mariusz Smykula

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT_SEPARATOR
static String	ELEMENT_SEPARATOR_WITH_NEWLINE
static StandardRepresentation	STANDARD_REPRESENTATION

Constructor Summary

Constructors

Constructor and Description
StandardRepresentation()

Method Summary

Modifier and Type	Method and Description
protected <T> String	customFormat(T object)
protected String	fallbackToStringOf(Object object) Returns the String representation of the given object.
String	format(Iterable<?> iterable, String start, String end, String elementSeparator, String indentation)
protected String	format(Object[] array, String elementSeparator, String indentation, Set<Object[]> alreadyFormatted)
protected String	formatArray(Object o) Returns the String representation of the given array, or null if the given object is either null or not an array.
protected String	formatPrimitiveArray(Object o)
static int	getMaxLengthForSingleLineDescription()
protected boolean	hasCustomFormatterFor(Object object)
protected String	multiLineFormat(Iterable<?> iterable)
protected String	multiLineFormat(Representation representation, Object[] iterable, Set<Object[]> alreadyFormatted)
static <T> void	registerFormatterForType(Class<T> type, Function<T,String> formatter) Registers new formatter for the given type.
static void	removeAllRegisteredFormatters() Clear all formatters registered per type with registerFormatterForType(Class, Function).
static void	resetDefaults() It resets the static defaults for the standard representation.
static void	setMaxElementsForPrinting(int value)
static void	setMaxLengthForSingleLineDescription(int value)
protected String	singleLineFormat(Iterable<?> iterable, String start, String end)
protected String	singleLineFormat(Representation representation, Object[] iterable, String start, String end, Set<Object[]> alreadyFormatted)
protected String	smartFormat(Iterable<?> iterable) Returns the String representation of the given Iterable, or null if the given Iterable is null.
protected String	smartFormat(Representation representation, Object[] iterable)
String	toString()
protected String	toStringOf(AtomicBoolean atomicBoolean)
protected String	toStringOf(AtomicInteger atomicInteger)
protected String	toStringOf(AtomicLong atomicLong)
protected String	toStringOf(AtomicMarkableReference<?> atomicMarkableReference)
protected String	toStringOf(AtomicReference<?> atomicReference)
protected String	toStringOf(AtomicStampedReference<?> atomicStampedReference)
protected String	toStringOf(Calendar c)
protected String	toStringOf(Character c)
protected String	toStringOf(Class<?> c)
protected String	toStringOf(Comparator<?> comparator)
protected String	toStringOf(CompletableFuture<?> future)
protected String	toStringOf(Date d)
protected String	toStringOf(File f)
protected String	toStringOf(Float f)
protected String	toStringOf(Long l)
protected String	toStringOf(Map<?,?> map)
protected String	toStringOf(MapEntry<?,?> mapEntry)
protected String	toStringOf(Number number)
String	toStringOf(Object object) Returns standard the toString representation of the given object.
protected String	toStringOf(PredicateDescription p)
protected String	toStringOf(SimpleDateFormat dateFormat)
protected String	toStringOf(String s)
protected String	toStringOf(Tuple tuple)
String	unambiguousToStringOf(Object obj) Returns the String representation of the given object with its type and hexadecimal hash code so that it can be differentied from other objects with the same Representation.toStringOf(Object) representation.

Methods inherited from class java.lang.Object

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

Field Detail

STANDARD_REPRESENTATION

public static final StandardRepresentation STANDARD_REPRESENTATION

ELEMENT_SEPARATOR

public static final String ELEMENT_SEPARATOR

See Also:

Constant Field Values

ELEMENT_SEPARATOR_WITH_NEWLINE

public static final String ELEMENT_SEPARATOR_WITH_NEWLINE

Constructor Detail

StandardRepresentation

public StandardRepresentation()

Method Detail

resetDefaults

public static void resetDefaults()

It resets the static defaults for the standard representation.

The following defaults will be reapplied:

• maxLengthForSingleLineDescription = 80
• maxElementsForPrinting = 1000

setMaxLengthForSingleLineDescription

public static void setMaxLengthForSingleLineDescription(int value)

getMaxLengthForSingleLineDescription

public static int getMaxLengthForSingleLineDescription()

setMaxElementsForPrinting

public static void setMaxElementsForPrinting(int value)

registerFormatterForType

public static <T> void registerFormatterForType(Class<T> type,
                                                Function<T,String> formatter)

Registers new formatter for the given type. All instances of the given type will be formatted with the provided formatter.

Type Parameters:

T - the type to register a formatter for

Parameters:

type - the class of the type to register a formatter for

formatter - the formatter

removeAllRegisteredFormatters

public static void removeAllRegisteredFormatters()

Clear all formatters registered per type with registerFormatterForType(Class, Function).

toStringOf

public String toStringOf(Object object)

Returns standard the toString representation of the given object. It may or not the object's own implementation of toString.

Specified by:

toStringOf in interface Representation

Parameters:

object - the given object.

Returns:

the toString representation of the given object.

customFormat

protected <T> String customFormat(T object)

hasCustomFormatterFor

protected boolean hasCustomFormatterFor(Object object)

unambiguousToStringOf

public String unambiguousToStringOf(Object obj)

Description copied from interface: Representation

Returns the String representation of the given object with its type and hexadecimal hash code so that it can be differentied from other objects with the same Representation.toStringOf(Object) representation.

Specified by:

unambiguousToStringOf in interface Representation

Parameters:

obj - the object to represent.

Returns:

the toString representation of the given object.

fallbackToStringOf

protected String fallbackToStringOf(Object object)

Returns the String representation of the given object. This method is used as a last resort if none of the StandardRepresentation predefined string representations were not called.

Parameters:

object - the object to represent (never null

Returns:

to toString representation for the given object

toStringOf

protected String toStringOf(Number number)

toStringOf

protected String toStringOf(AtomicBoolean atomicBoolean)

toStringOf

protected String toStringOf(AtomicInteger atomicInteger)

toStringOf

protected String toStringOf(AtomicLong atomicLong)

toStringOf

protected String toStringOf(Comparator<?> comparator)

toStringOf

protected String toStringOf(Calendar c)

toStringOf

protected String toStringOf(Class<?> c)

toStringOf

protected String toStringOf(String s)

toStringOf

protected String toStringOf(Character c)

toStringOf

protected String toStringOf(PredicateDescription p)

toStringOf

protected String toStringOf(Date d)

toStringOf

protected String toStringOf(Float f)

toStringOf

protected String toStringOf(Long l)

toStringOf

protected String toStringOf(File f)

toStringOf

protected String toStringOf(SimpleDateFormat dateFormat)

toStringOf

protected String toStringOf(CompletableFuture<?> future)

toStringOf

protected String toStringOf(Tuple tuple)

toStringOf

protected String toStringOf(MapEntry<?,?> mapEntry)

toStringOf

protected String toStringOf(Map<?,?> map)

toStringOf

protected String toStringOf(AtomicReference<?> atomicReference)

toStringOf

protected String toStringOf(AtomicMarkableReference<?> atomicMarkableReference)

toStringOf

protected String toStringOf(AtomicStampedReference<?> atomicStampedReference)

toString

public String toString()

Overrides:

toString in class Object

formatArray

protected String formatArray(Object o)

Returns the String representation of the given array, or null if the given object is either null or not an array. This method supports arrays having other arrays as elements.

Parameters:

o - the object that is expected to be an array.

Returns:

the String representation of the given array.

multiLineFormat

protected String multiLineFormat(Representation representation,
                                 Object[] iterable,
                                 Set<Object[]> alreadyFormatted)

singleLineFormat

protected String singleLineFormat(Representation representation,
                                  Object[] iterable,
                                  String start,
                                  String end,
                                  Set<Object[]> alreadyFormatted)

smartFormat

protected String smartFormat(Representation representation,
                             Object[] iterable)

format

protected String format(Object[] array,
                        String elementSeparator,
                        String indentation,
                        Set<Object[]> alreadyFormatted)

formatPrimitiveArray

protected String formatPrimitiveArray(Object o)

format

public String format(Iterable<?> iterable,
                     String start,
                     String end,
                     String elementSeparator,
                     String indentation)

multiLineFormat

protected String multiLineFormat(Iterable<?> iterable)

singleLineFormat

protected String singleLineFormat(Iterable<?> iterable,
                                  String start,
                                  String end)

smartFormat

protected String smartFormat(Iterable<?> iterable)

Returns the String representation of the given Iterable, or null if the given Iterable is null.

The Iterable will be formatted to a single line if it does not exceed 100 char, otherwise each elements will be formatted on a new line with 4 space indentation.

Parameters:

iterable - the Iterable to format.

Returns:

the String representation of the given Iterable.