Class StandardToStringStyle

java.lang.Object

org.apache.commons.lang3.builder.ToStringStyle

org.apache.commons.lang3.builder.StandardToStringStyle

All Implemented Interfaces:

Serializable

public class StandardToStringStyle
extends ToStringStyle

Works with ToStringBuilder to create a toString.

This class is intended to be used as a singleton. There is no need to instantiate a new style each time. Simply instantiate the class once, customize the values as required, and store the result in a public static final variable for the rest of the program to access.

Since:

1.0

See Also:

• Serialized Form

Field Summary

Fields inherited from class ToStringStyle

DEFAULT_STYLE, JSON_STYLE, MULTI_LINE_STYLE, NO_CLASS_NAME_STYLE, NO_FIELD_NAMES_STYLE, SHORT_PREFIX_STYLE, SIMPLE_STYLE

Modifier and Type	Field	Description
static final ToStringStyle	DEFAULT_STYLE	The default toString style.
static final ToStringStyle	JSON_STYLE	The JSON toString style.
static final ToStringStyle	MULTI_LINE_STYLE	The multi line toString style.
static final ToStringStyle	NO_CLASS_NAME_STYLE	The no class name toString style.
static final ToStringStyle	NO_FIELD_NAMES_STYLE	The no field names toString style.
static final ToStringStyle	SHORT_PREFIX_STYLE	The short prefix toString style.
static final ToStringStyle	SIMPLE_STYLE	The simple toString style.

Constructor Summary

Constructors

Constructor	Description
StandardToStringStyle()	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
String	getArrayEnd()	Gets the array end text.
String	getArraySeparator()	Gets the array separator text.
String	getArrayStart()	Gets the array start text.
String	getContentEnd()	Gets the content end text.
String	getContentStart()	Gets the content start text.
String	getFieldNameValueSeparator()	Gets the field name value separator text.
String	getFieldSeparator()	Gets the field separator text.
String	getNullText()	Gets the text to output when null found.
String	getSizeEndText()	Gets the end text to output when a Collection, Map or Array size is output.
String	getSizeStartText()	Gets the text to output when a Collection, Map or Array size is output.
String	getSummaryObjectEndText()	Gets the end text to output when an Object is output in summary mode.
String	getSummaryObjectStartText()	Gets the start text to output when an Object is output in summary mode.
boolean	isArrayContentDetail()	Tests whether to output array content detail.
boolean	isDefaultFullDetail()	Tests whether full detail is used when the caller does not specify a detail level.
boolean	isFieldSeparatorAtEnd()	Tests whether the field separator should be added at the end of each buffer.
boolean	isFieldSeparatorAtStart()	Tests whether the field separator should be added at the start of each buffer.
boolean	isUseClassName()	Tests whether to use the class name.
boolean	isUseFieldNames()	Tests whether to use the field names passed in.
boolean	isUseIdentityHashCode()	Tests whether to use the identity hash code.
boolean	isUseShortClassName()	Tests whether short class names should be output.
void	setArrayContentDetail(boolean arrayContentDetail)	Sets whether to output array content detail.
void	setArrayEnd(String arrayEnd)	Sets the array end text.
void	setArraySeparator(String arraySeparator)	Sets the array separator text.
void	setArrayStart(String arrayStart)	Sets the array start text.
void	setContentEnd(String contentEnd)	Sets the content end text.
void	setContentStart(String contentStart)	Sets the content start text.
void	setDefaultFullDetail(boolean defaultFullDetail)	Sets whether to use full detail when the caller doesn't specify.
void	setFieldNameValueSeparator(String fieldNameValueSeparator)	Sets the field name value separator text.
void	setFieldSeparator(String fieldSeparator)	Sets the field separator text.
void	setFieldSeparatorAtEnd(boolean fieldSeparatorAtEnd)	Sets whether the field separator should be added at the end of each buffer.
void	setFieldSeparatorAtStart(boolean fieldSeparatorAtStart)	Sets whether the field separator should be added at the start of each buffer.
void	setNullText(String nullText)	Sets the text to output when null found.
void	setSizeEndText(String sizeEndText)	Sets the end text to output when a Collection, Map or Array size is output.
void	setSizeStartText(String sizeStartText)	Sets the start text to output when a Collection, Map or Array size is output.
void	setSummaryObjectEndText(String summaryObjectEndText)	Sets the end text to output when an Object is output in summary mode.
void	setSummaryObjectStartText(String summaryObjectStartText)	Sets the start text to output when an Object is output in summary mode.
void	setUseClassName(boolean useClassName)	Sets whether to use the class name.
void	setUseFieldNames(boolean useFieldNames)	Sets whether to use the field names passed in.
void	setUseIdentityHashCode(boolean useIdentityHashCode)	Sets whether to use the identity hash code.
void	setUseShortClassName(boolean useShortClassName)	Sets whether to output short or long class names.

Methods inherited from class ToStringStyle

append, append, append, append, append, append, append, append, append, append, append, append, append, append, append, append, append, append, appendClassName, appendContentEnd, appendContentStart, appendCyclicObject, appendDetail, appendDetail, appendDetail, appendDetail, appendDetail, appendDetail, appendDetail, appendDetail, appendDetail, appendDetail, appendDetail, appendDetail, appendDetail, appendDetail, appendDetail, appendDetail, appendDetail, appendDetail, appendDetail, appendDetail, appendDetail, appendEnd, appendFieldEnd, appendFieldSeparator, appendFieldStart, appendIdentityHashCode, appendInternal, appendNullText, appendStart, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummarySize, appendSuper, appendToString, getRegistry, getShortClassName, isFullDetail, reflectionAppendArrayDetail, removeLastFieldSeparator

Modifier and Type	Method	Description
void	append(StringBuffer buffer, String fieldName, boolean value)	Appends to the toString a boolean value.
void	append(StringBuffer buffer, String fieldName, boolean[] array, Boolean fullDetail)	Appends to the toString a boolean array.
void	append(StringBuffer buffer, String fieldName, byte value)	Appends to the toString a byte value.
void	append(StringBuffer buffer, String fieldName, byte[] array, Boolean fullDetail)	Appends to the toString a byte array.
void	append(StringBuffer buffer, String fieldName, char value)	Appends to the toString a char value.
void	append(StringBuffer buffer, String fieldName, char[] array, Boolean fullDetail)	Appends to the toString a char array.
void	append(StringBuffer buffer, String fieldName, double value)	Appends to the toString a double value.
void	append(StringBuffer buffer, String fieldName, double[] array, Boolean fullDetail)	Appends to the toString a double array.
void	append(StringBuffer buffer, String fieldName, float value)	Appends to the toString a float value.
void	append(StringBuffer buffer, String fieldName, float[] array, Boolean fullDetail)	Appends to the toString a float array.
void	append(StringBuffer buffer, String fieldName, int value)	Appends to the toString an int value.
void	append(StringBuffer buffer, String fieldName, int[] array, Boolean fullDetail)	Appends to the toString an int array.
void	append(StringBuffer buffer, String fieldName, long value)	Appends to the toString a long value.
void	append(StringBuffer buffer, String fieldName, long[] array, Boolean fullDetail)	Appends to the toString a long array.
void	append(StringBuffer buffer, String fieldName, short value)	Appends to the toString a short value.
void	append(StringBuffer buffer, String fieldName, short[] array, Boolean fullDetail)	Appends to the toString a short array.
void	append(StringBuffer buffer, String fieldName, Object[] array, Boolean fullDetail)	Appends to the toString an Object array.
void	append(StringBuffer buffer, String fieldName, Object value, Boolean fullDetail)	Appends to the toString an Object value, printing the full toString of the Object passed in.
protected void	appendClassName(StringBuffer buffer, Object object)	Appends to the toString the class name.
protected void	appendContentEnd(StringBuffer buffer)	Appends to the toString the content end.
protected void	appendContentStart(StringBuffer buffer)	Appends to the toString the content start.
protected void	appendCyclicObject(StringBuffer buffer, String fieldName, Object value)	Appends to the toString an Object value that has been detected to participate in a cycle.
protected void	appendDetail(StringBuffer buffer, String fieldName, boolean value)	Appends to the toString a boolean value.
protected void	appendDetail(StringBuffer buffer, String fieldName, boolean[] array)	Appends to the toString the detail of a boolean array.
protected void	appendDetail(StringBuffer buffer, String fieldName, byte value)	Appends to the toString a byte value.
protected void	appendDetail(StringBuffer buffer, String fieldName, byte[] array)	Appends to the toString the detail of a byte array.
protected void	appendDetail(StringBuffer buffer, String fieldName, char value)	Appends to the toString a char value.
protected void	appendDetail(StringBuffer buffer, String fieldName, char[] array)	Appends to the toString the detail of a char array.
protected void	appendDetail(StringBuffer buffer, String fieldName, double value)	Appends to the toString a double value.
protected void	appendDetail(StringBuffer buffer, String fieldName, double[] array)	Appends to the toString the detail of a double array.
protected void	appendDetail(StringBuffer buffer, String fieldName, float value)	Appends to the toString a float value.
protected void	appendDetail(StringBuffer buffer, String fieldName, float[] array)	Appends to the toString the detail of a float array.
protected void	appendDetail(StringBuffer buffer, String fieldName, int value)	Appends to the toString an int value.
protected void	appendDetail(StringBuffer buffer, String fieldName, int[] array)	Appends to the toString the detail of an int array.
protected void	appendDetail(StringBuffer buffer, String fieldName, int i, Object item)	Appends to the toString the detail of an Object array item.
protected void	appendDetail(StringBuffer buffer, String fieldName, long value)	Appends to the toString a long value.
protected void	appendDetail(StringBuffer buffer, String fieldName, long[] array)	Appends to the toString the detail of a long array.
protected void	appendDetail(StringBuffer buffer, String fieldName, short value)	Appends to the toString a short value.
protected void	appendDetail(StringBuffer buffer, String fieldName, short[] array)	Appends to the toString the detail of a short array.
protected void	appendDetail(StringBuffer buffer, String fieldName, Object value)	Appends to the toString an Object value, printing the full detail of the Object.
protected void	appendDetail(StringBuffer buffer, String fieldName, Object[] array)	Appends to the toString the detail of an Object array.
protected void	appendDetail(StringBuffer buffer, String fieldName, Collection<?> coll)	Appends to the toString a Collection.
protected void	appendDetail(StringBuffer buffer, String fieldName, Map<?,?> map)	Appends to the toString a Map.
void	appendEnd(StringBuffer buffer, Object object)	Appends to the toString the end of data indicator.
protected void	appendFieldEnd(StringBuffer buffer, String fieldName)	Appends to the toString the field end.
protected void	appendFieldSeparator(StringBuffer buffer)	Appends to the toString the field separator.
protected void	appendFieldStart(StringBuffer buffer, String fieldName)	Appends to the toString the field start.
protected void	appendIdentityHashCode(StringBuffer buffer, Object object)	Appends the System.identityHashCode(java.lang.Object).
protected void	appendInternal(StringBuffer buffer, String fieldName, Object value, boolean detail)	Appends to the toString an Object, correctly interpreting its type.
protected void	appendNullText(StringBuffer buffer, String fieldName)	Appends to the toString an indicator for null.
void	appendStart(StringBuffer buffer, Object object)	Appends to the toString the start of data indicator.
protected void	appendSummary(StringBuffer buffer, String fieldName, boolean[] array)	Appends to the toString a summary of a boolean array.
protected void	appendSummary(StringBuffer buffer, String fieldName, byte[] array)	Appends to the toString a summary of a byte array.
protected void	appendSummary(StringBuffer buffer, String fieldName, char[] array)	Appends to the toString a summary of a char array.
protected void	appendSummary(StringBuffer buffer, String fieldName, double[] array)	Appends to the toString a summary of a double array.
protected void	appendSummary(StringBuffer buffer, String fieldName, float[] array)	Appends to the toString a summary of a float array.
protected void	appendSummary(StringBuffer buffer, String fieldName, int[] array)	Appends to the toString a summary of an int array.
protected void	appendSummary(StringBuffer buffer, String fieldName, long[] array)	Appends to the toString a summary of a long array.
protected void	appendSummary(StringBuffer buffer, String fieldName, short[] array)	Appends to the toString a summary of a short array.
protected void	appendSummary(StringBuffer buffer, String fieldName, Object value)	Appends to the toString an Object value, printing a summary of the Object.
protected void	appendSummary(StringBuffer buffer, String fieldName, Object[] array)	Appends to the toString a summary of an Object array.
protected void	appendSummarySize(StringBuffer buffer, String fieldName, int size)	Appends to the toString a size summary.
void	appendSuper(StringBuffer buffer, String superToString)	Appends to the toString the superclass toString.
void	appendToString(StringBuffer buffer, String toString)	Appends to the toString another toString.
static Map<Object,Object>	getRegistry()	Gets the registry of objects being traversed by the reflectionToString methods in the current thread.
protected String	getShortClassName(Class<?> cls)	Gets the short class name for a class.
protected boolean	isFullDetail(Boolean fullDetailRequest)	Tests whether this field should be output in full detail.
protected void	reflectionAppendArrayDetail(StringBuffer buffer, String fieldName, Object array)	Appends to the toString the detail of an array type.
protected void	removeLastFieldSeparator(StringBuffer buffer)	Remove the last field separator from the buffer.

Methods inherited from class Object

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

Constructor Details

StandardToStringStyle

public StandardToStringStyle()

Constructs a new instance.

Method Details

getArrayEnd

public String getArrayEnd()

Gets the array end text.

Overrides:

getArrayEnd in class ToStringStyle

Returns:

The current array end text

getArraySeparator

public String getArraySeparator()

Gets the array separator text.

Overrides:

getArraySeparator in class ToStringStyle

Returns:

The current array separator text

getArrayStart

public String getArrayStart()

Gets the array start text.

Overrides:

getArrayStart in class ToStringStyle

Returns:

The current array start text

getContentEnd

public String getContentEnd()

Gets the content end text.

Overrides:

getContentEnd in class ToStringStyle

Returns:

The current content end text

getContentStart

public String getContentStart()

Gets the content start text.

Overrides:

getContentStart in class ToStringStyle

Returns:

The current content start text

getFieldNameValueSeparator

public String getFieldNameValueSeparator()

Gets the field name value separator text.

Overrides:

getFieldNameValueSeparator in class ToStringStyle

Returns:

The current field name value separator text

getFieldSeparator

public String getFieldSeparator()

Gets the field separator text.

Overrides:

getFieldSeparator in class ToStringStyle

Returns:

The current field separator text

getNullText

public String getNullText()

Gets the text to output when null found.

Overrides:

getNullText in class ToStringStyle

Returns:

The current text to output when null found

getSizeEndText

public String getSizeEndText()

Gets the end text to output when a Collection, Map or Array size is output.

This is output after the size value.

Overrides:

getSizeEndText in class ToStringStyle

Returns:

The current end of size text

getSizeStartText

public String getSizeStartText()

Gets the text to output when a Collection, Map or Array size is output.

This is output before the size value.

Overrides:

getSizeStartText in class ToStringStyle

Returns:

The current start of size text

getSummaryObjectEndText

public String getSummaryObjectEndText()

Gets the end text to output when an Object is output in summary mode.

This is output after the size value.

Overrides:

getSummaryObjectEndText in class ToStringStyle

Returns:

The current end of summary text

getSummaryObjectStartText

public String getSummaryObjectStartText()

Gets the start text to output when an Object is output in summary mode.

This is output before the size value.

Overrides:

getSummaryObjectStartText in class ToStringStyle

Returns:

The current start of summary text

isArrayContentDetail

public boolean isArrayContentDetail()

Tests whether to output array content detail.

Overrides:

isArrayContentDetail in class ToStringStyle

Returns:

The current array content detail setting

isDefaultFullDetail

public boolean isDefaultFullDetail()

Tests whether full detail is used when the caller does not specify a detail level.

Overrides:

isDefaultFullDetail in class ToStringStyle

Returns:

The current defaultFullDetail flag

isFieldSeparatorAtEnd

public boolean isFieldSeparatorAtEnd()

Tests whether the field separator should be added at the end of each buffer.

Overrides:

isFieldSeparatorAtEnd in class ToStringStyle

Returns:

fieldSeparatorAtEnd flag

Since:

2.0

isFieldSeparatorAtStart

public boolean isFieldSeparatorAtStart()

Tests whether the field separator should be added at the start of each buffer.

Overrides:

isFieldSeparatorAtStart in class ToStringStyle

Returns:

The fieldSeparatorAtStart flag

Since:

2.0

isUseClassName

public boolean isUseClassName()

Tests whether to use the class name.

Overrides:

isUseClassName in class ToStringStyle

Returns:

The current useClassName flag

isUseFieldNames

public boolean isUseFieldNames()

Tests whether to use the field names passed in.

Overrides:

isUseFieldNames in class ToStringStyle

Returns:

The current useFieldNames flag

isUseIdentityHashCode

public boolean isUseIdentityHashCode()

Tests whether to use the identity hash code.

Overrides:

isUseIdentityHashCode in class ToStringStyle

Returns:

The current useIdentityHashCode flag

isUseShortClassName

public boolean isUseShortClassName()

Tests whether short class names should be output.

Overrides:

isUseShortClassName in class ToStringStyle

Returns:

The current useShortClassName flag

Since:

2.0

setArrayContentDetail

public void setArrayContentDetail(boolean arrayContentDetail)

Sets whether to output array content detail.

Overrides:

setArrayContentDetail in class ToStringStyle

Parameters:

arrayContentDetail - The new arrayContentDetail flag

setArrayEnd

public void setArrayEnd(String arrayEnd)

Sets the array end text.

null is accepted, but will be converted to an empty String.

Overrides:

setArrayEnd in class ToStringStyle

Parameters:

arrayEnd - The new array end text

setArraySeparator

public void setArraySeparator(String arraySeparator)

Sets the array separator text.

null is accepted, but will be converted to an empty String.

Overrides:

setArraySeparator in class ToStringStyle

Parameters:

arraySeparator - The new array separator text

setArrayStart

public void setArrayStart(String arrayStart)

Sets the array start text.

null is accepted, but will be converted to an empty String.

Overrides:

setArrayStart in class ToStringStyle

Parameters:

arrayStart - The new array start text

setContentEnd

public void setContentEnd(String contentEnd)

Sets the content end text.

null is accepted, but will be converted to an empty String.

Overrides:

setContentEnd in class ToStringStyle

Parameters:

contentEnd - The new content end text

setContentStart

public void setContentStart(String contentStart)

Sets the content start text.

null is accepted, but will be converted to an empty String.

Overrides:

setContentStart in class ToStringStyle

Parameters:

contentStart - The new content start text

setDefaultFullDetail

public void setDefaultFullDetail(boolean defaultFullDetail)

Sets whether to use full detail when the caller doesn't specify.

Overrides:

setDefaultFullDetail in class ToStringStyle

Parameters:

defaultFullDetail - The new defaultFullDetail flag

setFieldNameValueSeparator

public void setFieldNameValueSeparator(String fieldNameValueSeparator)

Sets the field name value separator text.

null is accepted, but will be converted to an empty String.

Overrides:

setFieldNameValueSeparator in class ToStringStyle

Parameters:

fieldNameValueSeparator - The new field name value separator text

setFieldSeparator

public void setFieldSeparator(String fieldSeparator)

Sets the field separator text.

null is accepted, but will be converted to an empty String.

Overrides:

setFieldSeparator in class ToStringStyle

Parameters:

fieldSeparator - The new field separator text

setFieldSeparatorAtEnd

public void setFieldSeparatorAtEnd(boolean fieldSeparatorAtEnd)

Sets whether the field separator should be added at the end of each buffer.

Overrides:

setFieldSeparatorAtEnd in class ToStringStyle

Parameters:

fieldSeparatorAtEnd - The fieldSeparatorAtEnd flag

Since:

2.0

setFieldSeparatorAtStart

public void setFieldSeparatorAtStart(boolean fieldSeparatorAtStart)

Sets whether the field separator should be added at the start of each buffer.

Overrides:

setFieldSeparatorAtStart in class ToStringStyle

Parameters:

fieldSeparatorAtStart - The fieldSeparatorAtStart flag

Since:

2.0

setNullText

public void setNullText(String nullText)

Sets the text to output when null found.

null is accepted, but will be converted to an empty String.

Overrides:

setNullText in class ToStringStyle

Parameters:

nullText - The new text to output when null found

setSizeEndText

public void setSizeEndText(String sizeEndText)

Sets the end text to output when a Collection, Map or Array size is output.

This is output after the size value.

null is accepted, but will be converted to an empty String.

Overrides:

setSizeEndText in class ToStringStyle

Parameters:

sizeEndText - The new end of size text

setSizeStartText

public void setSizeStartText(String sizeStartText)

Sets the start text to output when a Collection, Map or Array size is output.

This is output before the size value.

null is accepted, but will be converted to an empty String.

Overrides:

setSizeStartText in class ToStringStyle

Parameters:

sizeStartText - The new start of size text

setSummaryObjectEndText

public void setSummaryObjectEndText(String summaryObjectEndText)

Sets the end text to output when an Object is output in summary mode.

This is output after the size value.

null is accepted, but will be converted to an empty String.

Overrides:

setSummaryObjectEndText in class ToStringStyle

Parameters:

summaryObjectEndText - The new end of summary text

setSummaryObjectStartText

public void setSummaryObjectStartText(String summaryObjectStartText)

Sets the start text to output when an Object is output in summary mode.

This is output before the size value.

null is accepted, but will be converted to an empty String.

Overrides:

setSummaryObjectStartText in class ToStringStyle

Parameters:

summaryObjectStartText - The new start of summary text

setUseClassName

public void setUseClassName(boolean useClassName)

Sets whether to use the class name.

Overrides:

setUseClassName in class ToStringStyle

Parameters:

useClassName - The new useClassName flag

setUseFieldNames

public void setUseFieldNames(boolean useFieldNames)

Sets whether to use the field names passed in.

Overrides:

setUseFieldNames in class ToStringStyle

Parameters:

useFieldNames - The new useFieldNames flag

setUseIdentityHashCode

public void setUseIdentityHashCode(boolean useIdentityHashCode)

Sets whether to use the identity hash code.

Overrides:

setUseIdentityHashCode in class ToStringStyle

Parameters:

useIdentityHashCode - The new useIdentityHashCode flag

setUseShortClassName

public void setUseShortClassName(boolean useShortClassName)

Sets whether to output short or long class names.

Overrides:

setUseShortClassName in class ToStringStyle

Parameters:

useShortClassName - The new useShortClassName flag

Since:

2.0