Helps with the construction of good Object#toString() representations.

You can customize the output using the builder-style methods ToStringBuilder#singleLine() ToStringBuilder#skipNulls() and ToStringBuilder#hideFieldNames().

You can either directly list fields to include via ToStringBuilder#add(String, Object) and ToStringBuilder#add(Object) or you can let the builder do it automatically using reflection, either including the fields declared in this class or including all superclasses.

The builder will automatically handle cycles in the object tree. It also pretty prints arrays and Iterables.

This class is not thread safe.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	ToStringBuilder.IndentationAwareStringBuilder
private static class	ToStringBuilder.Part

Field Summary

Modifier and Type	Field and Description
private final Object	instance
private boolean	multiLine
private final List<ToStringBuilder.Part>	parts
private boolean	prettyPrint
private boolean	showFieldNames
private boolean	skipNulls
private static ToStringContext	toStringContext
private final String	typeName

Constructor Summary

Access	Constructor and Description
public	ToStringBuilder(final Object the object to convert to a String instance) Creates a new ToStringBuilder for the given object.

Method Summary

Modifier and Type	Method and Description
public ToStringBuilder	Returns: this add(final String the field name to list the value under fieldName, final Object the value to add to the output value)
public ToStringBuilder	Returns: this add(final Object the value to add to the output without a field name value)
public ToStringBuilder	Returns: this addAllFields() Adds all fields declared in the object's class and its superclasses to the output.
public ToStringBuilder	Returns: this addDeclaredFields() Adds all fields declared directly in the object's class to the output
public ToStringBuilder	Returns: this addField(final String the name of the field to add to the output using reflection fieldName)
private ToStringBuilder	addField(final Field field)
private ToStringBuilder.Part	addPart()
private ToStringBuilder	addPart(final Object value)
private ToStringBuilder	addPart(final String fieldName, final Object value)
private List<Field>	getAllDeclaredFields(final Class<?> clazz)
public ToStringBuilder	Returns: this hideFieldNames() Field names will not be included in the output.
private void	internalToString(final Object object, final ToStringBuilder.IndentationAwareStringBuilder sb)
private void	serializeIterable(final Iterable<?> object, final ToStringBuilder.IndentationAwareStringBuilder sb)
public ToStringBuilder	Returns: this singleLine() Fields are printed on a single line, separated by commas instead of newlines
public ToStringBuilder	Returns: this skipNulls() Fields with null values will be excluded from the output
private String	toSimpleReferenceString(final Object obj)
public String	Returns: the String representation of the processed object toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public ToStringBuilder	Returns: this verbatimValues() By default, Iterables, Arrays and multiline Strings are pretty-printed.

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

Field Detail

instance	back to summary
private final Object instance

multiLine	back to summary
private boolean multiLine

parts	back to summary
private final List<ToStringBuilder.Part> parts

prettyPrint	back to summary
private boolean prettyPrint

showFieldNames	back to summary
private boolean showFieldNames

skipNulls	back to summary
private boolean skipNulls

toStringContext	back to summary
private static ToStringContext toStringContext

typeName	back to summary
private final String typeName

Constructor Detail

ToStringBuilder	back to summary
public ToStringBuilder(final Object instance) Creates a new ToStringBuilder for the given object. If you don't use reflection, then this instance is only used for obtaining its classes' simple name. Parameters instance:Object the object to convert to a String

ToStringBuilder

back to summary

public ToStringBuilder(final Object instance)

Creates a new ToStringBuilder for the given object. If you don't use reflection, then this instance is only used for obtaining its classes' simple name.

Parameters

instance:Object: the object to convert to a String

Method Detail

add	back to summary
public ToStringBuilder add(final String fieldName, final Object value) Parameters fieldName:String the field name to list the value under value:Object the value to add to the output Returns:ToStringBuilder this

add	back to summary
public ToStringBuilder add(final Object value) Parameters value:Object the value to add to the output without a field name Returns:ToStringBuilder this

addAllFields	back to summary
public ToStringBuilder addAllFields() Adds all fields declared in the object's class and its superclasses to the output. Returns:ToStringBuilder this Annotations @GwtIncompatible:Class.getDeclaredFields

addAllFields

back to summary

public ToStringBuilder addAllFields()

Adds all fields declared in the object's class and its superclasses to the output.

Returns:ToStringBuilder

this

Annotations

@GwtIncompatible:Class.getDeclaredFields

addDeclaredFields	back to summary
public ToStringBuilder addDeclaredFields() Adds all fields declared directly in the object's class to the output Returns:ToStringBuilder this Annotations @GwtIncompatible:Class.getDeclaredFields

addDeclaredFields

back to summary

public ToStringBuilder addDeclaredFields()

Adds all fields declared directly in the object's class to the output

Returns:ToStringBuilder

this

Annotations

@GwtIncompatible:Class.getDeclaredFields

addField	back to summary
public ToStringBuilder addField(final String fieldName) Parameters fieldName:String the name of the field to add to the output using reflection Returns:ToStringBuilder this Annotations @GwtIncompatible:Class.getDeclaredField(String)

addField	back to summary
private ToStringBuilder addField(final Field field) Annotations @GwtIncompatible:Field

addPart	back to summary
private ToStringBuilder.Part addPart()

addPart	back to summary
private ToStringBuilder addPart(final Object value)

addPart	back to summary
private ToStringBuilder addPart(final String fieldName, final Object value)

getAllDeclaredFields	back to summary
private List<Field> getAllDeclaredFields(final Class<?> clazz) Annotations @GwtIncompatible:Field

hideFieldNames	back to summary
public ToStringBuilder hideFieldNames() Field names will not be included in the output. Useful for small classes. Returns:ToStringBuilder this

hideFieldNames

back to summary

public ToStringBuilder hideFieldNames()

Field names will not be included in the output. Useful for small classes.

Returns:ToStringBuilder: this

internalToString	back to summary
private void internalToString(final Object object, final ToStringBuilder.IndentationAwareStringBuilder sb)

serializeIterable	back to summary
private void serializeIterable(final Iterable<?> object, final ToStringBuilder.IndentationAwareStringBuilder sb)

singleLine	back to summary
public ToStringBuilder singleLine() Fields are printed on a single line, separated by commas instead of newlines Returns:ToStringBuilder this

singleLine

back to summary

public ToStringBuilder singleLine()

Fields are printed on a single line, separated by commas instead of newlines

Returns:ToStringBuilder: this

skipNulls	back to summary
public ToStringBuilder skipNulls() Fields with null values will be excluded from the output Returns:ToStringBuilder this

skipNulls

back to summary

public ToStringBuilder skipNulls()

Fields with null values will be excluded from the output

Returns:ToStringBuilder: this

toSimpleReferenceString	back to summary
private String toSimpleReferenceString(final Object obj)

toString back to summary

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. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String the String representation of the processed object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

the String representation of the processed object

Annotations

@Override

verbatimValues	back to summary
public ToStringBuilder verbatimValues() By default, Iterables, Arrays and multiline Strings are pretty-printed. Switching to their normal representation makes the toString method significantly faster. Returns:ToStringBuilder this Since 2.9

verbatimValues

back to summary

public ToStringBuilder verbatimValues()

By default, Iterables, Arrays and multiline Strings are pretty-printed. Switching to their normal representation makes the toString method significantly faster.

Returns:ToStringBuilder: this
Since: 2.9

org.eclipse.xtext.xbase.lib.util back to summary

private Class ToStringBuilder.IndentationAwareStringBuilder

Class Inheritance

extends Object

java.lang.Object
org.eclipse.xtext.xbase.lib.util.ToStringBuilder.IndentationAwareStringBuilder

Field Summary

Modifier and Type	Field and Description
private final StringBuilder	builder
private int	indentation
private final String	indentationString
private final String	newLineString

Constructor Summary

Access	Constructor and Description
private	IndentationAwareStringBuilder()

Method Summary

Modifier and Type	Method and Description
public ToStringBuilder.IndentationAwareStringBuilder	append(final CharSequence string)
public ToStringBuilder.IndentationAwareStringBuilder	decreaseIndent()
public ToStringBuilder.IndentationAwareStringBuilder	increaseIndent()
public ToStringBuilder.IndentationAwareStringBuilder	newLine()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

builder	back to summary
private final StringBuilder builder

indentation	back to summary
private int indentation

indentationString	back to summary
private final String indentationString

newLineString	back to summary
private final String newLineString

Constructor Detail

IndentationAwareStringBuilder	back to summary
private IndentationAwareStringBuilder()

Method Detail

append	back to summary
public ToStringBuilder.IndentationAwareStringBuilder append(final CharSequence string)

decreaseIndent	back to summary
public ToStringBuilder.IndentationAwareStringBuilder decreaseIndent()

increaseIndent	back to summary
public ToStringBuilder.IndentationAwareStringBuilder increaseIndent()

newLine	back to summary
public ToStringBuilder.IndentationAwareStringBuilder newLine()

toString back to summary

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. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public final Class ToStringBuilder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ToStringBuilder.IndentationAwareStringBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ToStringBuilder.Part

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail