Top Description Inners Fields Constructors Methods
org.apache.commons.lang3.builder

public abstract Class ToStringStyle

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Known Direct Subclasses
org.apache.commons.lang3.builder.ToStringStyle.DefaultToStringStyle, org.apache.commons.lang3.builder.ToStringStyle.JsonToStringStyle, org.apache.commons.lang3.builder.ToStringStyle.MultiLineToStringStyle, org.apache.commons.lang3.builder.ToStringStyle.NoClassNameToStringStyle, org.apache.commons.lang3.builder.ToStringStyle.NoFieldNameToStringStyle, org.apache.commons.lang3.builder.ToStringStyle.ShortPrefixToStringStyle, org.apache.commons.lang3.builder.ToStringStyle.SimpleToStringStyle, org.apache.commons.lang3.builder.RecursiveToStringStyle, org.apache.commons.lang3.builder.StandardToStringStyle
Annotations
@SuppressWarnings:deprecation
Imports
java.io.Serializable, java.lang.reflect.Array, java.util.Collection, .Map, .Map.Entry, .Objects, .WeakHashMap, org.apache.commons.lang3.ClassUtils, .ObjectUtils, .StringEscapeUtils, .StringUtils, .Strings
Controls String formatting for ToStringBuilder. The main public interface is always via ToStringBuilder.

These classes are intended to be used as singletons. There is no need to instantiate a new style each time. A program will generally use one of the predefined constants on this class. Alternatively, the StandardToStringStyle class can be used to set the individual settings. Thus most styles can be achieved without subclassing.

If required, a subclass can override as many or as few of the methods as it requires. Each object type (from boolean to long to Object to int[]) has its own methods to output it. Most have two versions, detail and summary.

For example, the detail version of the array based methods will output the whole array, whereas the summary method will just output the array length.

If you want to format the output of certain objects, such as dates, you must create a subclass and override a method. 

public class MyStyle extends ToStringStyle {

    protected void appendDetail(StringBuffer buffer, String fieldName, Object value) {
        if (value instanceof Date) {
            value = new SimpleDateFormat("yyyy-MM-dd").format(value);
        }
        buffer.append(value);
    }
}
Since
1.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
ToStringStyle.DefaultToStringStyle

Default ToStringStyle.

private static class
ToStringStyle.JsonToStringStyle

ToStringStyle that outputs with JSON format.

private static class
ToStringStyle.MultiLineToStringStyle

ToStringStyle that outputs on multiple lines.

private static class
ToStringStyle.NoClassNameToStringStyle

ToStringStyle that does not print out the class name and identity hash code but prints content start and field names.

private static class
ToStringStyle.NoFieldNameToStringStyle

ToStringStyle that does not print out the field names.

private static class
ToStringStyle.ShortPrefixToStringStyle

ToStringStyle that prints out the short class name and no identity hash code.

private static class
ToStringStyle.SimpleToStringStyle

ToStringStyle that does not print out the class name, identity hash code, content start or field name.

Field Summary

Modifier and TypeField and Description
private boolean
arrayContentDetail

The detail for array content.

private String
arrayEnd

The array end ''}.

private String
arraySeparator

The array separator ','.

private String
arrayStart

The array start '{'.

private String
contentEnd

The content end ']'.

private String
contentStart

The content start '['.

public static final ToStringStyle
DEFAULT_STYLE

The default toString style.

private boolean
defaultFullDetail

The value to use when fullDetail is null, the default value is true.

private String
fieldNameValueSeparator

The field name value separator '='.

private String
fieldSeparator

The field separator ','.

private boolean
fieldSeparatorAtEnd

Whether the field separator should be added after any other fields.

private boolean
fieldSeparatorAtStart

Whether the field separator should be added before any other fields.

public static final ToStringStyle
JSON_STYLE

The JSON toString style.

public static final ToStringStyle
MULTI_LINE_STYLE

The multi line toString style.

public static final ToStringStyle
NO_CLASS_NAME_STYLE

The no class name toString style.

public static final ToStringStyle
NO_FIELD_NAMES_STYLE

The no field names toString style.

private String
nullText

The null text "<null>".

private static final ThreadLocal<WeakHashMap<Object, Object>>
REGISTRY

A registry of objects used by reflectionToString methods to detect cyclical object references and avoid infinite loops.

private static final long
serialVersionUID

Serialization version ID.

public static final ToStringStyle
SHORT_PREFIX_STYLE

The short prefix toString style.

public static final ToStringStyle
SIMPLE_STYLE

The simple toString style.

private String
sizeEndText

The summary size text start ">".

private String
sizeStartText

The summary size text start "<size=".

private String
summaryObjectEndText

The summary object text start ">".

private String
summaryObjectStartText

The summary object text start "<".

private boolean
useClassName

Whether to use the class name, the default is true.

private boolean
useFieldNames

Whether to use the field names, the default is true.

private boolean
useIdentityHashCode

Whether to use the identity hash code, the default is true.

private boolean
useShortClassName

Whether to use short class names, the default is false.

Constructor Summary

AccessConstructor and Description
protected
ToStringStyle()

Constructs a new instance.

Method Summary

Modifier and TypeMethod and Description
public void
append(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name.
fieldName, final boolean
the value to add to the toString.
value)

Appends to the toString a boolean value.

public void
append(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name.
fieldName, final boolean[]
the array to add to the toString.
array, final Boolean
true for detail, false for summary info, null for style decides.
fullDetail)

Appends to the toString a boolean array.

public void
append(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name.
fieldName, final byte
the value to add to the toString.
value)

Appends to the toString a byte value.

public void
append(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name.
fieldName, final byte[]
the array to add to the toString.
array, final Boolean
true for detail, false for summary info, null for style decides.
fullDetail)

Appends to the toString a byte array.

public void
append(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name.
fieldName, final char
the value to add to the toString.
value)

Appends to the toString a char value.

public void
append(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name.
fieldName, final char[]
the array to add to the toString.
array, final Boolean
true for detail, false for summary info, null for style decides.
fullDetail)

Appends to the toString a char array.

public void
append(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name.
fieldName, final double
the value to add to the toString.
value)

Appends to the toString a double value.

public void
append(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name.
fieldName, final double[]
the array to add to the toString.
array, final Boolean
true for detail, false for summary info, null for style decides.
fullDetail)

Appends to the toString a double array.

public void
append(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name.
fieldName, final float
the value to add to the toString.
value)

Appends to the toString a float value.

public void
append(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name.
fieldName, final float[]
the array to add to the toString.
array, final Boolean
true for detail, false for summary info, null for style decides.
fullDetail)

Appends to the toString a float array.

public void
append(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name.
fieldName, final int
the value to add to the toString.
value)

Appends to the toString an int value.

public void
append(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name.
fieldName, final int[]
the array to add to the toString.
array, final Boolean
true for detail, false for summary info, null for style decides.
fullDetail)

Appends to the toString an int array.

public void
append(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name.
fieldName, final long
the value to add to the toString.
value)

Appends to the toString a long value.

public void
append(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name.
fieldName, final long[]
the array to add to the toString.
array, final Boolean
true for detail, false for summary info, null for style decides.
fullDetail)

Appends to the toString a long array.

public void
append(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name.
fieldName, final Object
the value to add to the toString.
value, final Boolean
true for detail, false for summary info, null for style decides.
fullDetail)

Appends to the toString an Object value, printing the full toString of the Object passed in.

public void
append(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name.
fieldName, final Object[]
the array to add to the toString.
array, final Boolean
true for detail, false for summary info, null for style decides.
fullDetail)

Appends to the toString an Object array.

public void
append(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name.
fieldName, final short
the value to add to the toString.
value)

Appends to the toString a short value.

public void
append(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name.
fieldName, final short[]
the array to add to the toString.
array, final Boolean
true for detail, false for summary info, null for style decides.
fullDetail)

Appends to the toString a short array.

protected void
appendClassName(final StringBuffer
the StringBuffer to populate.
buffer, final Object
the Object whose name to output.
object)

Appends to the toString the class name.

protected void
appendContentEnd(final StringBuffer
the StringBuffer to populate.
buffer)

Appends to the toString the content end.

protected void
appendContentStart(final StringBuffer
the StringBuffer to populate.
buffer)

Appends to the toString the content start.

protected void
appendCyclicObject(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended
fieldName, final Object
the value to add to the toString, not null.
value)

Appends to the toString an Object value that has been detected to participate in a cycle.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final boolean
the value to add to the toString.
value)

Appends to the toString a boolean value.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final boolean[]
the array to add to the toString, not null.
array)

Appends to the toString the detail of a boolean array.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final byte
the value to add to the toString.
value)

Appends to the toString a byte value.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final byte[]
the array to add to the toString, not null.
array)

Appends to the toString the detail of a byte array.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final char
the value to add to the toString.
value)

Appends to the toString a char value.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final char[]
the array to add to the toString, not null.
array)

Appends to the toString the detail of a char array.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final Collection<?>
the Collection to add to the toString, not null.
coll)

Appends to the toString a Collection.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final double
the value to add to the toString.
value)

Appends to the toString a double value.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended
fieldName, final double[]
the array to add to the toString, not null.
array)

Appends to the toString the detail of a double array.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final float
the value to add to the toString.
value)

Appends to the toString a float value.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final float[]
the array to add to the toString, not null.
array)

Appends to the toString the detail of a float array.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final int
the value to add to the toString.
value)

Appends to the toString an int value.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final int
the array item index to add.
i, final Object
the array item to add.
item)

Appends to the toString the detail of an Object array item.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final int[]
the array to add to the toString, not null.
array)

Appends to the toString the detail of an int array.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final long
the value to add to the toString.
value)

Appends to the toString a long value.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final long[]
the array to add to the toString, not null.
array)

Appends to the toString the detail of a long array.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final Map<?, ?>
the Map to add to the toString, not null.
map)

Appends to the toString a Map.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final Object
the value to add to the toString, not null.
value)

Appends to the toString an Object value, printing the full detail of the Object.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final Object[]
the array to add to the toString, not null.
array)

Appends to the toString the detail of an Object array.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final short
the value to add to the toString.
value)

Appends to the toString a short value.

protected void
appendDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final short[]
the array to add to the toString, not null.
array)

Appends to the toString the detail of a short array.

public void
appendEnd(final StringBuffer
the StringBuffer to populate.
buffer, final Object
the Object to build a toString for.
object)

Appends to the toString the end of data indicator.

protected void
appendFieldEnd(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName)

Appends to the toString the field end.

protected void
appendFieldSeparator(final StringBuffer
the StringBuffer to populate.
buffer)

Appends to the toString the field separator.

protected void
appendFieldStart(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name.
fieldName)

Appends to the toString the field start.

protected void
appendIdentityHashCode(final StringBuffer
the StringBuffer to populate.
buffer, final Object
the Object whose id to output.
object)

Appends the System#identityHashCode(java.lang.Object).

protected void
appendInternal(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final Object
the value to add to the toString, not null.
value, final boolean
output detail or not.
detail)

Appends to the toString an Object, correctly interpreting its type.

protected void
appendNullText(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName)

Appends to the toString an indicator for null.

public void
appendStart(final StringBuffer
the StringBuffer to populate.
buffer, final Object
the Object to build a toString for.
object)

Appends to the toString the start of data indicator.

protected void
appendSummary(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final boolean[]
the array to add to the toString, not null.
array)

Appends to the toString a summary of a boolean array.

protected void
appendSummary(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final byte[]
the array to add to the toString, not null.
array)

Appends to the toString a summary of a byte array.

protected void
appendSummary(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final char[]
the array to add to the toString, not null.
array)

Appends to the toString a summary of a char array.

protected void
appendSummary(final StringBuffer
the StringBuffer to populate
buffer, final String
the field name, typically not used as already appended
fieldName, final double[]
the array to add to the toString, not null
array)

Appends to the toString a summary of a double array.

protected void
appendSummary(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final float[]
the array to add to the toString, not null.
array)

Appends to the toString a summary of a float array.

protected void
appendSummary(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final int[]
the array to add to the toString, not null.
array)

Appends to the toString a summary of an int array.

protected void
appendSummary(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final long[]
the array to add to the toString, not null.
array)

Appends to the toString a summary of a long array.

protected void
appendSummary(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final Object
the value to add to the toString, not null.
value)

Appends to the toString an Object value, printing a summary of the Object.

protected void
appendSummary(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final Object[]
the array to add to the toString, not null.
array)

Appends to the toString a summary of an Object array.

protected void
appendSummary(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final short[]
the array to add to the toString, not null.
array)

Appends to the toString a summary of a short array.

protected void
appendSummarySize(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final int
the size to append.
size)

Appends to the toString a size summary.

public void
appendSuper(final StringBuffer
the StringBuffer to populate.
buffer, final String
the super.toString().
superToString)

Appends to the toString the superclass toString.

public void
appendToString(final StringBuffer
the StringBuffer to populate.
buffer, final String
the additional toString.
toString)

Appends to the toString another toString.

protected String

Returns:

the current array end text.
getArrayEnd()

Gets the array end text.

protected String

Returns:

the current array separator text.
getArraySeparator()

Gets the array separator text.

protected String

Returns:

the current array start text.
getArrayStart()

Gets the array start text.

protected String

Returns:

the current content end text.
getContentEnd()

Gets the content end text.

protected String

Returns:

the current content start text.
getContentStart()

Gets the content start text.

protected String

Returns:

the current field name value separator text.
getFieldNameValueSeparator()

Gets the field name value separator text.

protected String

Returns:

the current field separator text.
getFieldSeparator()

Gets the field separator text.

protected String

Returns:

the current text to output when null found.
getNullText()

Gets the text to output when null found.

public static Map<Object, Object>

Returns:

Set the registry of objects being traversed.
getRegistry()

Gets the registry of objects being traversed by the reflectionToString methods in the current thread.

protected String

Returns:

the short name.
getShortClassName(final Class<?>
the Class to get the short name of.
cls)

Gets the short class name for a class.

protected String

Returns:

the current end of size text.
getSizeEndText()

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

protected String

Returns:

the current start of size text.
getSizeStartText()

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

protected String

Returns:

the current end of summary text.
getSummaryObjectEndText()

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

protected String

Returns:

the current start of summary text.
getSummaryObjectStartText()

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

protected boolean

Returns:

the current array content detail setting.
isArrayContentDetail()

Gets whether to output array content detail.

protected boolean

Returns:

the current defaultFullDetail flag.
isDefaultFullDetail()

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

protected boolean

Returns:

fieldSeparatorAtEnd flag.
isFieldSeparatorAtEnd()

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

protected boolean

Returns:

the fieldSeparatorAtStart flag.
isFieldSeparatorAtStart()

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

protected boolean

Returns:

whether full detail is to be shown.
isFullDetail(final Boolean
the detail level requested.
fullDetailRequest)

Is this field to be output in full detail.

pack-priv static boolean

Returns:

boolean true if the registry contains the given object.
isRegistered(final Object
The object to lookup in the registry.
value)

Tests whether the registry contains the given object.

protected boolean

Returns:

the current useClassName flag.
isUseClassName()

Gets whether to use the class name.

protected boolean

Returns:

the current useFieldNames flag.
isUseFieldNames()

Gets whether to use the field names passed in.

protected boolean

Returns:

the current useIdentityHashCode flag.
isUseIdentityHashCode()

Gets whether to use the identity hash code.

protected boolean

Returns:

the current useShortClassName flag.
isUseShortClassName()

Gets whether to output short or long class names.

protected void
reflectionAppendArrayDetail(final StringBuffer
the StringBuffer to populate.
buffer, final String
the field name, typically not used as already appended.
fieldName, final Object
the array to add to the toString, not null.
array)

Appends to the toString the detail of an array type.

pack-priv static void
register(final Object
The object to register.
value)

Registers the given object.

protected void
removeLastFieldSeparator(final StringBuffer
the StringBuffer to populate.
buffer)

Remove the last field separator from the buffer.

protected void
setArrayContentDetail(final boolean
the new arrayContentDetail flag.
arrayContentDetail)

Sets whether to output array content detail.

protected void
setArrayEnd(final String
the new array end text.
arrayEnd)

Sets the array end text.

protected void
setArraySeparator(final String
the new array separator text.
arraySeparator)

Sets the array separator text.

protected void
setArrayStart(final String
the new array start text.
arrayStart)

Sets the array start text.

protected void
setContentEnd(final String
the new content end text.
contentEnd)

Sets the content end text.

protected void
setContentStart(final String
the new content start text.
contentStart)

Sets the content start text.

protected void
setDefaultFullDetail(final boolean
the new defaultFullDetail flag.
defaultFullDetail)

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

protected void
setFieldNameValueSeparator(final String
the new field name value separator text.
fieldNameValueSeparator)

Sets the field name value separator text.

protected void
setFieldSeparator(final String
the new field separator text.
fieldSeparator)

Sets the field separator text.

protected void
setFieldSeparatorAtEnd(final boolean
the fieldSeparatorAtEnd flag.
fieldSeparatorAtEnd)

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

protected void
setFieldSeparatorAtStart(final boolean
the fieldSeparatorAtStart flag.
fieldSeparatorAtStart)

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

protected void
setNullText(final String
the new text to output when null found.
nullText)

Sets the text to output when null found.

protected void
setSizeEndText(final String
the new end of size text.
sizeEndText)

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

protected void
setSizeStartText(final String
the new start of size text.
sizeStartText)

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

protected void
setSummaryObjectEndText(final String
the new end of summary text.
summaryObjectEndText)

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

protected void
setSummaryObjectStartText(final String
the new start of summary text.
summaryObjectStartText)

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

protected void
setUseClassName(final boolean
the new useClassName flag.
useClassName)

Sets whether to use the class name.

protected void
setUseFieldNames(final boolean
the new useFieldNames flag.
useFieldNames)

Sets whether to use the field names passed in.

protected void
setUseIdentityHashCode(final boolean
the new useIdentityHashCode flag.
useIdentityHashCode)

Sets whether to use the identity hash code.

protected void
setUseShortClassName(final boolean
the new useShortClassName flag.
useShortClassName)

Sets whether to output short or long class names.

pack-priv static void
unregister(final Object
The object to unregister.
value)

Unregisters the given object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait