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

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);
 }
 }
 

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

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

Is this field to be output in full detail.

This method converts a detail request into a detail level. The calling code may request full detail (true), but a subclass might ignore that and always return false.

Returns true if the registry contains the given object. Used by the reflection methods to avoid infinite loops.

Registers the given object.

Unregisters the given object.

Constructor.

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

Append to the toString a long value.

Append to the toString an int value.

Append to the toString a short value.

Append to the toString a byte value.

Append to the toString a char value.

Append to the toString a double value.

Append to the toString a float value.

Append to the toString a boolean value.

Append to the toString an Object array.

Append to the toString a long array.

Append to the toString an int array.

Append to the toString a short array.

Append to the toString a byte array.

Append to the toString a char array.

Append to the toString a double array.

Append to the toString a float array.

Append to the toString a boolean array.

Append to the toString the class name.

Append to the toString the content end.

Append to the toString the content start.

Append to the toString an Object value that has been detected to participate in a cycle. This implementation will print the standard string value of the value.

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

Append to the toString a Collection.

Append to the toString a Map.

Append to the toString a long value.

Append to the toString an int value.

Append to the toString a short value.

Append to the toString a byte value.

Append to the toString a char value.

Append to the toString a double value.

Append to the toString a float value.

Append to the toString a boolean value.

Append to the toString the detail of an Object array.

Append to the toString the detail of a long array.

Append to the toString the detail of an int array.

Append to the toString the detail of a short array.

Append to the toString the detail of a byte array.

Append to the toString the detail of a char array.

Append to the toString the detail of a double array.

Append to the toString the detail of a float array.

Append to the toString the detail of a boolean array.

Append to the toString the end of data indicator.

Append to the toString the field end.

Append to the toString the field separator.

Append to the toString the field start.

Append the System.identityHashCode(java.lang.Object) .

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

This method performs the main lookup by Class type to correctly route arrays, Collections, Maps and Objects to the appropriate method.

Either detail or summary views can be specified.

If a cycle is detected, an object will be appended with the Object.toString() format.

Append to the toString an indicator for null.

The default indicator is '<null>'.

Append to the toString the start of data indicator.

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

Append to the toString a summary of an Object array.

Append to the toString a summary of a long array.

Append to the toString a summary of an int array.

Append to the toString a summary of a short array.

Append to the toString a summary of a byte array.

Append to the toString a summary of a char array.

Append to the toString a summary of a double array.

Append to the toString a summary of a float array.

Append to the toString a summary of a boolean array.

Append to the toString a size summary.

The size summary is used to summarize the contents of Collections, Maps and arrays.

The output consists of a prefix, the passed in size and a suffix.

The default format is '<size=n>'.

Append to the toString the superclass toString.

A null superToString is ignored.

Append to the toString another toString.

A null toString is ignored.

Gets the array end text.

Gets the array separator text.

Gets the array start text.

Gets the content end text.

Gets the content start text.

Gets the field name value separator text.

Gets the field separator text.

Gets the text to output when null found.

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

Gets the short class name for a class.

The short class name is the classname excluding the package name.

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

This is output after the size value.

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

This is output before the size value.

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

This is output after the size value.

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

This is output before the size value.

Gets whether to output array content detail.

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

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

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

Is this field to be output in full detail.

This method converts a detail request into a detail level. The calling code may request full detail (true), but a subclass might ignore that and always return false. The calling code may pass in null indicating that it doesn't care about the detail level. In this case the default detail level is used.

Returns true if the registry contains the given object. Used by the reflection methods to avoid infinite loops.

Gets whether to output short or long class names.

Gets whether to use the class name.

Gets whether to use the field names passed in.

Gets whether to use the identity hash code.

Gets whether to output short or long class names.

Append to the toString the detail of an array type.

Registers the given object. Used by the reflection methods to avoid infinite loops.

Remove the last field separator from the buffer.

Sets whether to output array content detail.

Sets the array end text.

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

Sets the array separator text.

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

Sets the array start text.

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

Sets the content end text.

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

Sets the content start text.

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

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

Sets the field name value separator text.

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

Sets the field separator text.

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

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

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

Sets the text to output when null found.

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

Sets whether to output short or long class names.

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.

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.

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.

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.

Sets whether to use the class name.

Sets whether to use the field names passed in.

Sets whether to use the identity hash code.

Sets whether to output short or long class names.

Unregisters the given object.

Used by the reflection methods to avoid infinite loops.