Class MultilineRecursiveToStringStyle

java.lang.Object

org.apache.commons.lang3.builder.ToStringStyle

org.apache.commons.lang3.builder.RecursiveToStringStyle

org.apache.commons.lang3.builder.MultilineRecursiveToStringStyle

All Implemented Interfaces:

Serializable

public class MultilineRecursiveToStringStyle
extends RecursiveToStringStyle

Works with ToStringBuilder to create a "deep" toString. But instead a single line like the RecursiveToStringStyle this creates a multiline String similar to the ToStringStyle.MULTI_LINE_STYLE.

To use this class write code as follows:

public class Job {
  String title;
  ...
}

public class Person {
  String name;
  int age;
  boolean smoker;
  Job job;

  ...

  public String toString() {
    return new ReflectionToStringBuilder(this, new MultilineRecursiveToStringStyle()).toString();
  }
}

This will produce a toString of the format:
Person@7f54[ <br> &nbsp; name=Stephen, <br> &nbsp; age=29, <br> &nbsp; smokealse, <br> &nbsp; job=Job@43cd2[ <br> &nbsp; &nbsp; title=Manager <br> &nbsp; ] <br> ]

Since:

3.4

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class RecursiveToStringStyle

RecursiveToStringStyle.Builder

Modifier and Type	Class	Description
static class	RecursiveToStringStyle.Builder	Builder for RecursiveToStringStyle instances.

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
MultilineRecursiveToStringStyle()	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
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[] array)	Appends to the toString the detail of a byte array.
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[] array)	Appends to the toString the detail of a double array.
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[] array)	Appends to the toString the detail of an int array.
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[] array)	Appends to the toString the detail of a short array.
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	reflectionAppendArrayDetail(StringBuffer buffer, String fieldName, Object array)	Appends to the toString the detail of an array type.

Methods inherited from class RecursiveToStringStyle

accept, append, appendDetail, appendInternal, builder

Modifier and Type	Method	Description
protected boolean	accept(Class<?> clazz)	Tests whether or not to recursively format the given Class.
void	append(StringBuffer buffer, String fieldName, Object[] array, Boolean fullDetail)	Appends to the toString an Object array.
protected void	appendDetail(StringBuffer buffer, String fieldName, Collection<?> coll)	Appends to the toString a Collection.
protected void	appendInternal(StringBuffer buffer, String fieldName, Object value, boolean detail)	Appends to the toString an Object, correctly interpreting its type.
static RecursiveToStringStyle.Builder	builder()	Creates a new RecursiveToStringStyle.Builder for RecursiveToStringStyle instances.

Methods inherited from class ToStringStyle

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, appendEnd, appendFieldEnd, appendFieldSeparator, appendFieldStart, appendIdentityHashCode, appendNullText, appendStart, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummarySize, appendSuper, appendToString, getArrayEnd, getArraySeparator, getArrayStart, getContentEnd, getContentStart, getFieldNameValueSeparator, getFieldSeparator, getNullText, getRegistry, getShortClassName, getSizeEndText, getSizeStartText, getSummaryObjectEndText, getSummaryObjectStartText, isArrayContentDetail, isDefaultFullDetail, isFieldSeparatorAtEnd, isFieldSeparatorAtStart, isFullDetail, isUseClassName, isUseFieldNames, isUseIdentityHashCode, isUseShortClassName, removeLastFieldSeparator, setArrayContentDetail, setArrayEnd, setArraySeparator, setArrayStart, setContentEnd, setContentStart, setDefaultFullDetail, setFieldNameValueSeparator, setFieldSeparator, setFieldSeparatorAtEnd, setFieldSeparatorAtStart, setNullText, setSizeEndText, setSizeStartText, setSummaryObjectEndText, setSummaryObjectStartText, setUseClassName, setUseFieldNames, setUseIdentityHashCode, setUseShortClassName

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 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, byte value)	Appends to the toString a byte value.
protected void	appendDetail(StringBuffer buffer, String fieldName, char value)	Appends to the toString a char value.
protected void	appendDetail(StringBuffer buffer, String fieldName, double value)	Appends to the toString a double value.
protected void	appendDetail(StringBuffer buffer, String fieldName, float value)	Appends to the toString a float value.
protected void	appendDetail(StringBuffer buffer, String fieldName, int value)	Appends to the toString an int value.
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, short value)	Appends to the toString a short value.
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	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.
protected String	getArrayEnd()	Gets the array end text.
protected String	getArraySeparator()	Gets the array separator text.
protected String	getArrayStart()	Gets the array start text.
protected String	getContentEnd()	Gets the content end text.
protected String	getContentStart()	Gets the content start text.
protected String	getFieldNameValueSeparator()	Gets the field name value separator text.
protected String	getFieldSeparator()	Gets the field separator text.
protected String	getNullText()	Gets the text to output when null found.
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 String	getSizeEndText()	Gets the end text to output when a Collection, Map or array size is output.
protected String	getSizeStartText()	Gets the start text to output when a Collection, Map or array size is output.
protected String	getSummaryObjectEndText()	Gets the end text to output when an Object is output in summary mode.
protected String	getSummaryObjectStartText()	Gets the start text to output when an Object is output in summary mode.
protected boolean	isArrayContentDetail()	Tests whether to output array content detail.
protected boolean	isDefaultFullDetail()	Tests whether full detail is used when the caller does not specify a detail level.
protected boolean	isFieldSeparatorAtEnd()	Tests whether the field separator should be added at the end of each buffer.
protected boolean	isFieldSeparatorAtStart()	Tests whether the field separator should be added at the start of each buffer.
protected boolean	isFullDetail(Boolean fullDetailRequest)	Tests whether this field should be output in full detail.
protected boolean	isUseClassName()	Tests whether to use the class name.
protected boolean	isUseFieldNames()	Tests whether to use the field names passed in.
protected boolean	isUseIdentityHashCode()	Tests whether to use the identity hash code.
protected boolean	isUseShortClassName()	Tests whether short class names should be output.
protected void	removeLastFieldSeparator(StringBuffer buffer)	Remove the last field separator from the buffer.
protected void	setArrayContentDetail(boolean arrayContentDetail)	Sets whether to output array content detail.
protected void	setArrayEnd(String arrayEnd)	Sets the array end text.
protected void	setArraySeparator(String arraySeparator)	Sets the array separator text.
protected void	setArrayStart(String arrayStart)	Sets the array start text.
protected void	setContentEnd(String contentEnd)	Sets the content end text.
protected void	setContentStart(String contentStart)	Sets the content start text.
protected void	setDefaultFullDetail(boolean defaultFullDetail)	Sets whether to use full detail when the caller doesn't specify.
protected void	setFieldNameValueSeparator(String fieldNameValueSeparator)	Sets the field name value separator text.
protected void	setFieldSeparator(String fieldSeparator)	Sets the field separator text.
protected void	setFieldSeparatorAtEnd(boolean fieldSeparatorAtEnd)	Sets whether the field separator should be added at the end of each buffer.
protected void	setFieldSeparatorAtStart(boolean fieldSeparatorAtStart)	Sets whether the field separator should be added at the start of each buffer.
protected void	setNullText(String nullText)	Sets the text to output when null found.
protected void	setSizeEndText(String sizeEndText)	Sets the end text to output when a Collection, Map or array size is output.
protected void	setSizeStartText(String sizeStartText)	Sets the start text to output when a Collection, Map or array size is output.
protected void	setSummaryObjectEndText(String summaryObjectEndText)	Sets the end text to output when an Object is output in summary mode.
protected void	setSummaryObjectStartText(String summaryObjectStartText)	Sets the start text to output when an Object is output in summary mode.
protected void	setUseClassName(boolean useClassName)	Sets whether to use the class name.
protected void	setUseFieldNames(boolean useFieldNames)	Sets whether to use the field names passed in.
protected void	setUseIdentityHashCode(boolean useIdentityHashCode)	Sets whether to use the identity hash code.
protected void	setUseShortClassName(boolean useShortClassName)	Sets whether to output short or long class names.

Methods inherited from class Object

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

Constructor Details

MultilineRecursiveToStringStyle

public MultilineRecursiveToStringStyle()

Constructs a new instance.

Method Details

appendDetail

protected void appendDetail(StringBuffer buffer,
 String fieldName,
 boolean[] array)

Description copied from class: ToStringStyle

Appends to the toString the detail of a boolean array.

Overrides:

appendDetail in class ToStringStyle

Parameters:

buffer - The StringBuffer to populate.

fieldName - The field name, typically not used as already appended.

array - The array to add to the toString, not null.

appendDetail

protected void appendDetail(StringBuffer buffer,
 String fieldName,
 byte[] array)

Description copied from class: ToStringStyle

Appends to the toString the detail of a byte array.

Overrides:

appendDetail in class ToStringStyle

Parameters:

buffer - The StringBuffer to populate.

fieldName - The field name, typically not used as already appended.

array - The array to add to the toString, not null.

appendDetail

protected void appendDetail(StringBuffer buffer,
 String fieldName,
 char[] array)

Description copied from class: ToStringStyle

Appends to the toString the detail of a char array.

Overrides:

appendDetail in class ToStringStyle

Parameters:

buffer - The StringBuffer to populate.

fieldName - The field name, typically not used as already appended.

array - The array to add to the toString, not null.

appendDetail

protected void appendDetail(StringBuffer buffer,
 String fieldName,
 double[] array)

Description copied from class: ToStringStyle

Appends to the toString the detail of a double array.

Overrides:

appendDetail in class ToStringStyle

Parameters:

buffer - The StringBuffer to populate.

fieldName - The field name, typically not used as already appended

array - The array to add to the toString, not null.

appendDetail

protected void appendDetail(StringBuffer buffer,
 String fieldName,
 float[] array)

Description copied from class: ToStringStyle

Appends to the toString the detail of a float array.

Overrides:

appendDetail in class ToStringStyle

Parameters:

buffer - The StringBuffer to populate.

fieldName - The field name, typically not used as already appended.

array - The array to add to the toString, not null.

appendDetail

protected void appendDetail(StringBuffer buffer,
 String fieldName,
 int[] array)

Description copied from class: ToStringStyle

Appends to the toString the detail of an int array.

Overrides:

appendDetail in class ToStringStyle

Parameters:

buffer - The StringBuffer to populate.

fieldName - The field name, typically not used as already appended.

array - The array to add to the toString, not null.

appendDetail

protected void appendDetail(StringBuffer buffer,
 String fieldName,
 long[] array)

Description copied from class: ToStringStyle

Appends to the toString the detail of a long array.

Overrides:

appendDetail in class ToStringStyle

Parameters:

buffer - The StringBuffer to populate.

fieldName - The field name, typically not used as already appended.

array - The array to add to the toString, not null.

appendDetail

public void appendDetail(StringBuffer buffer,
 String fieldName,
 Object value)

Description copied from class: ToStringStyle

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

Overrides:

appendDetail in class RecursiveToStringStyle

Parameters:

buffer - The StringBuffer to populate.

fieldName - The field name, typically not used as already appended.

value - The value to add to the toString, not null.

appendDetail

protected void appendDetail(StringBuffer buffer,
 String fieldName,
 Object[] array)

Description copied from class: ToStringStyle

Appends to the toString the detail of an Object array.

Overrides:

appendDetail in class ToStringStyle

Parameters:

buffer - The StringBuffer to populate.

fieldName - The field name, typically not used as already appended.

array - The array to add to the toString, not null.

appendDetail

protected void appendDetail(StringBuffer buffer,
 String fieldName,
 short[] array)

Description copied from class: ToStringStyle

Appends to the toString the detail of a short array.

Overrides:

appendDetail in class ToStringStyle

Parameters:

buffer - The StringBuffer to populate.

fieldName - The field name, typically not used as already appended.

array - The array to add to the toString, not null.

reflectionAppendArrayDetail

protected void reflectionAppendArrayDetail(StringBuffer buffer,
 String fieldName,
 Object array)

Description copied from class: ToStringStyle

Appends to the toString the detail of an array type.

Overrides:

reflectionAppendArrayDetail in class ToStringStyle

Parameters:

buffer - The StringBuffer to populate.

fieldName - The field name, typically not used as already appended.

array - The array to add to the toString, not null.