AssertJ Core 3.26.0 · org.assertj.core.presentation.StandardRepresentation

Modifier and Type	Class and Description
protected static enum	StandardRepresentation.GroupType

Modifier and Type	Field and Description
private static final Class<?>[]	BLACKLISTED_ITERABLE_CLASSES
private static final Map<Class<?>, Function<?, ? extends CharSequence>>	customFormatterByType
private static final String	DEFAULT_END
private static final String	DEFAULT_MAX_ELEMENTS_EXCEEDED
private static final String	DEFAULT_START
public static final String	ELEMENT_SEPARATOR
public static final String	ELEMENT_SEPARATOR_WITH_NEWLINE
pack-priv static final String	INDENTATION_AFTER_NEWLINE
pack-priv static final String	INDENTATION_FOR_SINGLE_LINE
private static int	maxElementsForPrinting
private static int	maxLengthForSingleLineDescription
private static int	maxStackTraceElementsDisplayed
private static final String	NULL
public static final StandardRepresentation	STANDARD_REPRESENTATION
private static final String	TUPLE_END
private static final String	TUPLE_START
private static final Class<?>[]	TYPE_WITH_UNAMBIGUOUS_REPRESENTATION

Access	Constructor and Description
public	StandardRepresentation()

Method Summary

Modifier and Type	Method and Description
protected String	classNameDisambiguation(Object o)
private static Object	classNameOf(Object obj)
protected <T> String	customFormat(T object)
private String	defaultToStringWithClassNameDisambiguation(Object o)
private static boolean	doesDescriptionFitOnSingleLine(String singleLineDescription)
protected String	Returns: to `toString` representation for the given object fallbackToStringOf(Object the object to represent (never `null` object) Returns the `String` representation of the given object.
protected String	format(Object[] array, String start, String end, String elementSeparator, String indentation, Object root)
protected String	format(List<?> elements, String start, String end, String elementSeparator, String indentation, Object root)
protected String	format(Iterable<?> iterable, String start, String end, String elementSeparator, String indentation, Object root)
private String	format(Map<?, ?> map, Object o)
protected String	Returns: the `String` representation of the given array. formatArray(Object the object that is expected to be an array. o) Returns the `String` representation of the given array, or `null` if the given object is either `null` or not an array.
private String	formatLines(List<?> lines)
protected String	formatPrimitiveArray(Object o)
public static int	getMaxElementsForPrinting()
public static int	getMaxLengthForSingleLineDescription()
public static int	getMaxStackTraceElementsDisplayed()
protected boolean	Returns: true if the given object's type has a representation that is not ambiguous, false otherwise. hasAlreadyAnUnambiguousToStringOf(Object the object to check obj) Determine whether the given object's type has a representation that is not ambiguous.
protected boolean	hasCustomFormatterFor(Object object)
private static boolean	hasOverriddenToString(Class<?> clazz)
private static boolean	hasOverriddenToStringInSubclassOf(Class<?> objectClass, Class<?> clazz)
private static String	identityHexCodeOf(Object obj)
private static boolean	isInstanceOfNotOverridingToString(Object object, Class<?> type)
protected String	multiLineFormat(Iterable<?> iterable)
protected String	multiLineFormat(Object[] array, Object root)
public static < the type to register a formatter for T> void	registerFormatterForType(Class<T> the class of the type to register a formatter for type, Function<T, String> the formatter formatter) Registers new formatter for the given type.
public static void	removeAllRegisteredFormatters() Clear all formatters registered per type with `registerFormatterForType(Class, Function)`.
private List<String>	representElements(Iterable<?> elements, String start, String end, String elementSeparator, String indentation, Object root)
private static String	representGroup(List<String> representedElements, String start, String end, String elementSeparator, String indentation)
public static void	resetDefaults() It resets the static defaults for the standard representation.
protected String	safeStringOf(Object element, String start, String end, String elementSeparator, String indentation, Object root)
public static void	setMaxElementsForPrinting(int value)
public static void	setMaxLengthForSingleLineDescription(int value)
public static void	setMaxStackTraceElementsDisplayed(int value)
protected String	singleLineFormat(Iterable<?> iterable, String start, String end)
protected String	singleLineFormat(Object[] array, Object root)
protected String	Returns: the `String` representation of the given `Iterable`. smartFormat(Iterable<?> the `Iterable` to format. iterable) Returns the `String` representation of the given `Iterable`, or `null` if the given `Iterable` is `null`.
protected String	smartFormat(Object[] array)
private static Map<?, ?>	toSortedMapIfPossible(Map<?, ?> map)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public String	Returns: the `toString` representation of the given object. toStringOf(Object the given object. object) Implements org.assertj.core.presentation.Representation.toStringOf. Returns standard the `toString` representation of the given object.
protected String	toStringOf(Number number)
protected String	toStringOf(AtomicBoolean atomicBoolean)
protected String	toStringOf(AtomicInteger atomicInteger)
protected String	toStringOf(AtomicLong atomicLong)
protected String	toStringOf(LongAdder longAdder)
protected String	toStringOf(Comparator<?> comparator)
protected String	toStringOf(ComparatorBasedComparisonStrategy comparatorBasedComparisonStrategy)
protected String	toStringOf(Calendar calendar)
protected String	toStringOf(Class<?> c)
protected String	toStringOf(String s)
protected String	toStringOf(Character c)
protected String	toStringOf(PredicateDescription p)
protected String	toStringOf(Date date)
protected String	toStringOf(LocalDateTime localDateTime)
protected String	toStringOf(OffsetDateTime offsetDateTime)
protected String	toStringOf(ZonedDateTime zonedDateTime)
protected String	toStringOf(LocalDate localDate)
protected String	toStringOf(YearMonth yearMonth)
protected String	toStringOf(Float f)
protected String	toStringOf(Long l)
protected String	toStringOf(File file)
protected String	toStringOf(SimpleDateFormat dateFormat)
protected String	toStringOf(Future<?> future)
protected String	toStringOf(Tuple tuple)
protected String	toStringOf(MapEntry<?, ?> mapEntry)
protected String	toStringOf(Map.Entry<?, ?> javaMapEntry)
protected String	toStringOf(Map<?, ?> map)
protected String	toStringOf(Throwable throwable)
protected String	toStringOf(AtomicReference<?> atomicReference)
protected String	toStringOf(AtomicMarkableReference<?> atomicMarkableReference)
protected String	toStringOf(AtomicStampedReference<?> atomicStampedReference)
private String	toStringOf(ChangeDelta<?> changeDelta)
private String	toStringOf(DeleteDelta<?> deleteDelta)
private String	toStringOf(InsertDelta<?> insertDelta)
private String	toStringOf(Duration duration)
public String	Returns: the unambiguous `toString` representation of the given object. unambiguousToStringOf(Object the object to represent. obj) Overrides default org.assertj.core.presentation.Representation.unambiguousToStringOf. Returns the `String` representation of the given object with its type and hexadecimal identity hash code so that it can be differentiated from other objects with the same `toStringOf(Object)` representation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

BLACKLISTED_ITERABLE_CLASSES	back to summary
private static final Class<?>[] BLACKLISTED_ITERABLE_CLASSES

customFormatterByType	back to summary
private static final Map<Class<?>, Function<?, ? extends CharSequence>> customFormatterByType

DEFAULT_END	back to summary
private static final String DEFAULT_END

DEFAULT_MAX_ELEMENTS_EXCEEDED	back to summary
private static final String DEFAULT_MAX_ELEMENTS_EXCEEDED

DEFAULT_START	back to summary
private static final String DEFAULT_START

ELEMENT_SEPARATOR	back to summary
public static final String ELEMENT_SEPARATOR

ELEMENT_SEPARATOR_WITH_NEWLINE	back to summary
public static final String ELEMENT_SEPARATOR_WITH_NEWLINE

INDENTATION_AFTER_NEWLINE	back to summary
pack-priv static final String INDENTATION_AFTER_NEWLINE

INDENTATION_FOR_SINGLE_LINE	back to summary
pack-priv static final String INDENTATION_FOR_SINGLE_LINE

maxElementsForPrinting	back to summary
private static int maxElementsForPrinting

maxLengthForSingleLineDescription	back to summary
private static int maxLengthForSingleLineDescription

maxStackTraceElementsDisplayed	back to summary
private static int maxStackTraceElementsDisplayed

NULL	back to summary
private static final String NULL

STANDARD_REPRESENTATION	back to summary
public static final StandardRepresentation STANDARD_REPRESENTATION

TUPLE_END	back to summary
private static final String TUPLE_END

TUPLE_START	back to summary
private static final String TUPLE_START

TYPE_WITH_UNAMBIGUOUS_REPRESENTATION	back to summary
private static final Class<?>[] TYPE_WITH_UNAMBIGUOUS_REPRESENTATION

StandardRepresentation	back to summary
public StandardRepresentation()

Method Detail

classNameDisambiguation	back to summary
protected String classNameDisambiguation(Object o)

classNameOf	back to summary
private static Object classNameOf(Object obj)

customFormat	back to summary
protected <T> String customFormat(T object) Annotations @SuppressWarnings:unchecked

defaultToStringWithClassNameDisambiguation	back to summary
private String defaultToStringWithClassNameDisambiguation(Object o)

doesDescriptionFitOnSingleLine	back to summary
private static boolean doesDescriptionFitOnSingleLine(String singleLineDescription)

fallbackToStringOf back to summary

fallbackToStringOf	back to summary
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:Object the object to represent (never `null` Returns:String to `toString` representation for the given object

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:Object: the object to represent (never null

Returns:String

to toString representation for the given object

format	back to summary
protected String format(Object[] array, String start, String end, String elementSeparator, String indentation, Object root)

format	back to summary
protected String format(List<?> elements, String start, String end, String elementSeparator, String indentation, Object root)

format	back to summary
protected String format(Iterable<?> iterable, String start, String end, String elementSeparator, String indentation, Object root)

format	back to summary
private String format(Map<?, ?> map, Object o)

formatArray back to summary

formatArray	back to summary
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:Object the object that is expected to be an array. Returns:String the `String` representation of the given array.

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:Object: the object that is expected to be an array.

Returns:String

the String representation of the given array.

formatLines	back to summary
private String formatLines(List<?> lines)

formatPrimitiveArray	back to summary
protected String formatPrimitiveArray(Object o)

getMaxElementsForPrinting	back to summary
public static int getMaxElementsForPrinting() Annotations @VisibleForTesting

getMaxLengthForSingleLineDescription	back to summary
public static int getMaxLengthForSingleLineDescription() Annotations @VisibleForTesting

getMaxStackTraceElementsDisplayed	back to summary
public static int getMaxStackTraceElementsDisplayed() Annotations @VisibleForTesting

hasAlreadyAnUnambiguousToStringOf	back to summary
protected boolean hasAlreadyAnUnambiguousToStringOf(Object obj) Determine whether the given object's type has a representation that is not ambiguous. Parameters obj:Object the object to check Returns:boolean true if the given object's type has a representation that is not ambiguous, false otherwise.

hasAlreadyAnUnambiguousToStringOf

back to summary

protected boolean hasAlreadyAnUnambiguousToStringOf(Object obj)

Determine whether the given object's type has a representation that is not ambiguous.

Parameters

obj:Object: the object to check

Returns:boolean

true if the given object's type has a representation that is not ambiguous, false otherwise.

hasCustomFormatterFor	back to summary
protected boolean hasCustomFormatterFor(Object object)

hasOverriddenToString	back to summary
private static boolean hasOverriddenToString(Class<?> clazz)

hasOverriddenToStringInSubclassOf	back to summary
private static boolean hasOverriddenToStringInSubclassOf(Class<?> objectClass, Class<?> clazz)

identityHexCodeOf	back to summary
private static String identityHexCodeOf(Object obj)

isInstanceOfNotOverridingToString	back to summary
private static boolean isInstanceOfNotOverridingToString(Object object, Class<?> type)

multiLineFormat	back to summary
protected String multiLineFormat(Iterable<?> iterable)

multiLineFormat	back to summary
protected String multiLineFormat(Object[] array, Object root)

registerFormatterForType	back to summary
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. Parameters <T> the type to register a formatter for type:Class<T> the class of the type to register a formatter for formatter:Function<T, String> the formatter

registerFormatterForType

back to summary

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.

Parameters

<T>: the type to register a formatter for
type:Class<T>: the class of the type to register a formatter for
formatter:Function<T, String>: the formatter

removeAllRegisteredFormatters	back to summary
public static void removeAllRegisteredFormatters() Clear all formatters registered per type with `registerFormatterForType(Class, Function)`.

representElements	back to summary
private List<String> representElements(Iterable<?> elements, String start, String end, String elementSeparator, String indentation, Object root)

representGroup	back to summary
private static String representGroup(List<String> representedElements, String start, String end, String elementSeparator, String indentation)

resetDefaults back to summary

public static void resetDefaults()

It resets the static defaults for the standard representation.

The following defaults will be reapplied:

maxLengthForSingleLineDescription = 80
maxElementsForPrinting = 1000

safeStringOf	back to summary
protected String safeStringOf(Object element, String start, String end, String elementSeparator, String indentation, Object root)

setMaxElementsForPrinting	back to summary
public static void setMaxElementsForPrinting(int value)

setMaxLengthForSingleLineDescription	back to summary
public static void setMaxLengthForSingleLineDescription(int value)

setMaxStackTraceElementsDisplayed	back to summary
public static void setMaxStackTraceElementsDisplayed(int value)

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

singleLineFormat	back to summary
protected String singleLineFormat(Object[] array, Object root)

smartFormat back to summary

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 element will be formatted on a new line with 4 space indentation.

Parameters

iterable:Iterable<?>: the Iterable to format.

Returns:String

the String representation of the given Iterable.

smartFormat	back to summary
protected String smartFormat(Object[] array)

toSortedMapIfPossible	back to summary
private static Map<?, ?> toSortedMapIfPossible(Map<?, ?> map)

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

toStringOf back to summary

public String toStringOf(Object object)

Implements org.assertj.core.presentation.Representation.toStringOf.

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

Parameters

object:Object: the given object.

Returns:String

the toString representation of the given object.

Annotations

@Override

toStringOf	back to summary
protected String toStringOf(Number number)

toStringOf	back to summary
protected String toStringOf(AtomicBoolean atomicBoolean)

toStringOf	back to summary
protected String toStringOf(AtomicInteger atomicInteger)

toStringOf	back to summary
protected String toStringOf(AtomicLong atomicLong)

toStringOf	back to summary
protected String toStringOf(LongAdder longAdder)

toStringOf	back to summary
protected String toStringOf(Comparator<?> comparator)

toStringOf	back to summary
protected String toStringOf(ComparatorBasedComparisonStrategy comparatorBasedComparisonStrategy)

toStringOf	back to summary
protected String toStringOf(Class<?> c)

toStringOf	back to summary
protected String toStringOf(String s)

toStringOf	back to summary
protected String toStringOf(Character c)

toStringOf	back to summary
protected String toStringOf(PredicateDescription p)

toStringOf	back to summary
protected String toStringOf(Date date)

toStringOf	back to summary
protected String toStringOf(LocalDateTime localDateTime)

toStringOf	back to summary
protected String toStringOf(OffsetDateTime offsetDateTime)

toStringOf	back to summary
protected String toStringOf(ZonedDateTime zonedDateTime)

toStringOf	back to summary
protected String toStringOf(LocalDate localDate)

toStringOf	back to summary
protected String toStringOf(YearMonth yearMonth)

toStringOf	back to summary
protected String toStringOf(Float f)

toStringOf	back to summary
protected String toStringOf(Long l)

toStringOf	back to summary
protected String toStringOf(File file)

toStringOf	back to summary
protected String toStringOf(SimpleDateFormat dateFormat)

toStringOf	back to summary
protected String toStringOf(Future<?> future)

toStringOf	back to summary
protected String toStringOf(Tuple tuple)

toStringOf	back to summary
protected String toStringOf(MapEntry<?, ?> mapEntry)

toStringOf	back to summary
protected String toStringOf(Map.Entry<?, ?> javaMapEntry)

toStringOf	back to summary
protected String toStringOf(Map<?, ?> map)

toStringOf	back to summary
protected String toStringOf(Throwable throwable)

toStringOf	back to summary
protected String toStringOf(AtomicReference<?> atomicReference)

toStringOf	back to summary
protected String toStringOf(AtomicMarkableReference<?> atomicMarkableReference)

toStringOf	back to summary
protected String toStringOf(AtomicStampedReference<?> atomicStampedReference)

toStringOf	back to summary
private String toStringOf(ChangeDelta<?> changeDelta)

toStringOf	back to summary
private String toStringOf(DeleteDelta<?> deleteDelta)

toStringOf	back to summary
private String toStringOf(InsertDelta<?> insertDelta)

toStringOf	back to summary
private String toStringOf(Duration duration)

unambiguousToStringOf back to summary

public String unambiguousToStringOf(Object obj)

Overrides default org.assertj.core.presentation.Representation.unambiguousToStringOf.

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

Parameters

obj:Object: the object to represent.

Returns:String

the unambiguous toString representation of the given object.

Annotations

@Override

Modifier and Type	Method and Description
public String	description()
public static StandardRepresentation.GroupType	valueOf(String name)
public static StandardRepresentation.GroupType[]	values()

public Class StandardRepresentation

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected final Enum StandardRepresentation.GroupType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
public static final StandardRepresentation.GroupType	ARRAY
private String	description
public static final StandardRepresentation.GroupType	ITERABLE