Java Doc for ToStringBuilder.java in  » Library » Apache-common-lang » org » apache » commons » lang » builder » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Assists in implementing Object.toString methods.

This class enables a good and consistent toString() to be built for any class or object. This class aims to simplify the process by:

• allowing field names
• handling all types consistently
• handling nulls consistently
• outputting arrays and multi-dimensional arrays
• enabling the detail level to be controlled for Objects and Collections
• handling class hierarchies

To use this class write code as follows:

 public class Person {
 String name;
 int age;
 boolean smoker;
 ...
 public String toString() {
 return new ToStringBuilder(this).
 append("name", name).
 append("age", age).
 append("smoker", smoker).
 toString();
 }
 }
 

This will produce a toString of the format: Person@7f54[name=Stephen,age=29,smoker=false]

To add the superclass toString, use ToStringBuilder.appendSuper . To append the toString from an object that is delegated to (or any other object), use ToStringBuilder.appendToString .

Alternatively, there is a method that uses reflection to determine the fields to test. Because these fields are usually private, the method, reflectionToString, uses AccessibleObject.setAccessible to change the visibility of the fields. This will fail under a security manager, unless the appropriate permissions are set up correctly. It is also slower than testing explicitly.

A typical invocation for this method would look like:

 public String toString() {
 return ToStringBuilder.reflectionToString(this);
 }
 

You can also use the builder to debug 3rd party objects:

 System.out.println("An object: " + ToStringBuilder.reflectionToString(anObject));
 

The exact format of the toString is determined by the ToStringStyle passed into the constructor.

Append to the toString a boolean array.

A boolean parameter controls the level of detail to show. Setting true will output the array in full.

Append to the toString a byte array.

A boolean parameter controls the level of detail to show. Setting true will output the array in full.

Append to the toString a char array.

A boolean parameter controls the level of detail to show. Setting true will output the array in full.

Append to the toString a double array.

A boolean parameter controls the level of detail to show. Setting true will output the array in full.

Append to the toString a float array.

A boolean parameter controls the level of detail to show. Setting true will output the array in full.

Append to the toString an int array.

A boolean parameter controls the level of detail to show. Setting true will output the array in full.

Append to the toString a long array.

A boolean parameter controls the level of detail to show. Setting true will output the array in full.

Append to the toString an Object array.

A boolean parameter controls the level of detail to show. Setting true will output the array in full.

Append to the toString a short array.

A boolean parameter controls the level of detail to show. Setting true will output the array in full.

Appends with the same format as the default Object toString() method.

Append the toString from another object.

This method is useful where a class delegates most of the implementation of its properties to another class.

Returns the built toString.

This method appends the end of data indicator, and can only be called once.

Constructor for ToStringBuilder.

This constructor outputs using the default style set with setDefaultStyle.

Constructor for ToStringBuilder specifying the output style.

If the style is null, the default style is used.

Constructor for ToStringBuilder.

If the style is null, the default style is used.

If the buffer is null, a new one is created.

Append to the toString a boolean value.

Append to the toString a boolean array.

Append to the toString a byte value.

Append to the toString a byte array.

Append to the toString a char value.

Append to the toString a char array.

Append to the toString a double value.

Append to the toString a double array.

Append to the toString a float value.

Append to the toString a float array.

Append to the toString an int value.

Append to the toString an int array.

Append to the toString a long value.

Append to the toString a long array.

Append to the toString an Object value.

Append to the toString an Object array.

Append to the toString a short value.

Append to the toString a short array.

Append to the toString a boolean value.

Append to the toString a boolean array.

Append to the toString a boolean array.

A boolean parameter controls the level of detail to show. Setting true will output the array in full. Setting false will output a summary, typically the size of the array.

Append to the toString an byte value.

Append to the toString a byte array.

Append to the toString a byte array.

A boolean parameter controls the level of detail to show. Setting true will output the array in full. Setting false will output a summary, typically the size of the array.
Parameters:
  fieldName - the field name
Parameters:
  array - the array to add to the toString
Parameters:
  fullDetail - true for detail, falsefor summary info this

Append to the toString a char value.

Append to the toString a char array.

Append to the toString a char array.

A boolean parameter controls the level of detail to show. Setting true will output the array in full. Setting false will output a summary, typically the size of the array.

Append to the toString a double value.

Append to the toString a double array.

Append to the toString a double array.

A boolean parameter controls the level of detail to show. Setting true will output the array in full. Setting false will output a summary, typically the size of the array.

Append to the toString an float value.

Append to the toString a float array.

Append to the toString a float array.

A boolean parameter controls the level of detail to show. Setting true will output the array in full. Setting false will output a summary, typically the size of the array.

Append to the toString an int value.

Append to the toString an int array.

Append to the toString an int array.

A boolean parameter controls the level of detail to show. Setting true will output the array in full. Setting false will output a summary, typically the size of the array.

Append to the toString a long value.

Append to the toString a long array.

Append to the toString a long array.

A boolean parameter controls the level of detail to show. Setting true will output the array in full. Setting false will output a summary, typically the size of the array.

Append to the toString an Object value.

Append to the toString an Object value.

Append to the toString an Object array.

Append to the toString an Object array.

A boolean parameter controls the level of detail to show. Setting true will output the array in full. Setting false will output a summary, typically the size of the array.

Append to the toString an short value.

Append to the toString a short array.

Append to the toString a short array.

A boolean parameter controls the level of detail to show. Setting true will output the array in full. Setting false will output a summary, typically the size of the array.
Parameters:
  fieldName - the field name
Parameters:
  array - the array to add to the toString
Parameters:
  fullDetail - true for detail, falsefor summary info this

Appends with the same format as the default Object toString() method. Appends the class name followed by System.identityHashCode(java.lang.Object) .

Append the toString from the superclass.

This method assumes that the superclass uses the same ToStringStyle as this one.

If superToString is null, no change is made.

Append the toString from another object.

This method is useful where a class delegates most of the implementation of its properties to another class. You can then call toString() on the other class and pass the result into this method.

 private AnotherObject delegate;
 private String fieldInThisClass;
 public String toString() {
 return new ToStringBuilder(this).
 appendToString(delegate.toString()).
 append(fieldInThisClass).
 toString();
 }

This method assumes that the other object uses the same ToStringStyle as this one.

If the toString is null, no change is made.

Gets the default ToStringStyle to use.

This could allow the ToStringStyle to be controlled for an entire application with one call.

This might be used to have a verbose ToStringStyle during development and a compact ToStringStyle in production.

Returns the Object being output.

Gets the StringBuffer being populated.

Gets the ToStringStyle being used.

Forwards to ReflectionToStringBuilder.

Forwards to ReflectionToStringBuilder.

Forwards to ReflectionToStringBuilder.

Forwards to ReflectionToStringBuilder.

Sets the default ToStringStyle to use.

Returns the built toString.

This method appends the end of data indicator, and can only be called once. Use ToStringBuilder.getStringBuffer to get the current string state.

If the object is null, return the style's nullText