Home » commons-lang-2.5-src » org.apache.commons » lang » builder » [javadoc | source]
org.apache.commons.lang.builder
abstract public class: ToStringStyle [javadoc | source]
java.lang.Object
   org.apache.commons.lang.builder.ToStringStyle

All Implemented Interfaces:
    Serializable

Direct Known Subclasses:
    ShortPrefixToStringStyle, NoFieldNameToStringStyle, MultiLineToStringStyle, StandardToStringStyle, ToStringStyleImpl, DefaultToStringStyle, SimpleToStringStyle

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

Field Summary
public static final  ToStringStyle DEFAULT_STYLE    The default toString style. Using the Using the Person example from ToStringBuilder , the output would look like this:
Person@182f0db[name=John Doe,age=33,smoker=false]
 
public static final  ToStringStyle MULTI_LINE_STYLE    The multi line toString style. Using the Using the Person example from ToStringBuilder , the output would look like this:
Person@182f0db[
  name=John Doe
  age=33
  smoker=false
]
 
public static final  ToStringStyle NO_FIELD_NAMES_STYLE    The no field names toString style. Using the Using the Person example from ToStringBuilder , the output would look like this:
Person@182f0db[John Doe,33,false]
 
public static final  ToStringStyle SHORT_PREFIX_STYLE    The short prefix toString style. Using the Person example from ToStringBuilder , the output would look like this:
Person[name=John Doe,age=33,smoker=false]
    since: 2.1 -
 
public static final  ToStringStyle SIMPLE_STYLE    The simple toString style. Using the Using the Person example from ToStringBuilder , the output would look like this:
John Doe,33,false
 
Constructor:
 protected ToStringStyle() 
Method from org.apache.commons.lang.builder.ToStringStyle Summary:
append,   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,   appendDetail,   appendDetail,   appendDetail,   appendDetail,   appendDetail,   appendDetail,   appendDetail,   appendDetail,   appendDetail,   appendDetail,   appendEnd,   appendFieldEnd,   appendFieldSeparator,   appendFieldStart,   appendIdentityHashCode,   appendInternal,   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,   isRegistered,   isShortClassName,   isUseClassName,   isUseFieldNames,   isUseIdentityHashCode,   isUseShortClassName,   reflectionAppendArrayDetail,   register,   removeLastFieldSeparator,   setArrayContentDetail,   setArrayEnd,   setArraySeparator,   setArrayStart,   setContentEnd,   setContentStart,   setDefaultFullDetail,   setFieldNameValueSeparator,   setFieldSeparator,   setFieldSeparatorAtEnd,   setFieldSeparatorAtStart,   setNullText,   setShortClassName,   setSizeEndText,   setSizeStartText,   setSummaryObjectEndText,   setSummaryObjectStartText,   setUseClassName,   setUseFieldNames,   setUseIdentityHashCode,   setUseShortClassName,   unregister
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.commons.lang.builder.ToStringStyle Detail:
 public  void append(StringBuffer buffer,
    String fieldName,
    long value) 

    Append to the toString a long value.

 public  void append(StringBuffer buffer,
    String fieldName,
    int value) 

    Append to the toString an int value.

 public  void append(StringBuffer buffer,
    String fieldName,
    short value) 

    Append to the toString a short value.

 public  void append(StringBuffer buffer,
    String fieldName,
    byte value) 

    Append to the toString a byte value.

 public  void append(StringBuffer buffer,
    String fieldName,
    char value) 

    Append to the toString a char value.

 public  void append(StringBuffer buffer,
    String fieldName,
    double value) 

    Append to the toString a double value.

 public  void append(StringBuffer buffer,
    String fieldName,
    float value) 

    Append to the toString a float value.

 public  void append(StringBuffer buffer,
    String fieldName,
    boolean value) 

    Append to the toString a boolean value.

 public  void append(StringBuffer buffer,
    String fieldName,
    Object value,
    Boolean fullDetail) 

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

 public  void append(StringBuffer buffer,
    String fieldName,
    Object[] array,
    Boolean fullDetail) 

    Append to the toString an Object array.

 public  void append(StringBuffer buffer,
    String fieldName,
    long[] array,
    Boolean fullDetail) 

    Append to the toString a long array.

 public  void append(StringBuffer buffer,
    String fieldName,
    int[] array,
    Boolean fullDetail) 

    Append to the toString an int array.

 public  void append(StringBuffer buffer,
    String fieldName,
    short[] array,
    Boolean fullDetail) 

    Append to the toString a short array.

 public  void append(StringBuffer buffer,
    String fieldName,
    byte[] array,
    Boolean fullDetail) 

    Append to the toString a byte array.

 public  void append(StringBuffer buffer,
    String fieldName,
    char[] array,
    Boolean fullDetail) 

    Append to the toString a char array.

 public  void append(StringBuffer buffer,
    String fieldName,
    double[] array,
    Boolean fullDetail) 

    Append to the toString a double array.

 public  void append(StringBuffer buffer,
    String fieldName,
    float[] array,
    Boolean fullDetail) 

    Append to the toString a float array.

 public  void append(StringBuffer buffer,
    String fieldName,
    boolean[] array,
    Boolean fullDetail) 

    Append to the toString a boolean array.

 protected  void appendClassName(StringBuffer buffer,
    Object object) 

    Append to the toString the class name.

 protected  void appendContentEnd(StringBuffer buffer) 

    Append to the toString the content end.

 protected  void appendContentStart(StringBuffer buffer) 

    Append to the toString the content start.

 protected  void appendCyclicObject(StringBuffer buffer,
    String fieldName,
    Object value) 

    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.

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

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

 protected  void appendDetail(StringBuffer buffer,
    String fieldName,
    Collection coll) 

    Append to the toString a Collection.

 protected  void appendDetail(StringBuffer buffer,
    String fieldName,
    Map map) 

    Append to the toString a Map.

 protected  void appendDetail(StringBuffer buffer,
    String fieldName,
    long value) 

    Append to the toString a long value.

 protected  void appendDetail(StringBuffer buffer,
    String fieldName,
    int value) 

    Append to the toString an int value.

 protected  void appendDetail(StringBuffer buffer,
    String fieldName,
    short value) 

    Append to the toString a short value.

 protected  void appendDetail(StringBuffer buffer,
    String fieldName,
    byte value) 

    Append to the toString a byte value.

 protected  void appendDetail(StringBuffer buffer,
    String fieldName,
    char value) 

    Append to the toString a char value.

 protected  void appendDetail(StringBuffer buffer,
    String fieldName,
    double value) 

    Append to the toString a double value.

 protected  void appendDetail(StringBuffer buffer,
    String fieldName,
    float value) 

    Append to the toString a float value.

 protected  void appendDetail(StringBuffer buffer,
    String fieldName,
    boolean value) 

    Append to the toString a boolean value.

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

    Append to the toString the detail of an Object array.

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

    Append to the toString the detail of a long array.

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

    Append to the toString the detail of an int array.

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

    Append to the toString the detail of a short array.

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

    Append to the toString the detail of a byte array.

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

    Append to the toString the detail of a char array.

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

    Append to the toString the detail of a double array.

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

    Append to the toString the detail of a float array.

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

    Append to the toString the detail of a boolean array.

 public  void appendEnd(StringBuffer buffer,
    Object object) 

    Append to the toString the end of data indicator.

 protected  void appendFieldEnd(StringBuffer buffer,
    String fieldName) 

    Append to the toString the field end.

 protected  void appendFieldSeparator(StringBuffer buffer) 

    Append to the toString the field separator.

 protected  void appendFieldStart(StringBuffer buffer,
    String fieldName) 

    Append to the toString the field start.

 protected  void appendIdentityHashCode(StringBuffer buffer,
    Object object) 
 protected  void appendInternal(StringBuffer buffer,
    String fieldName,
    Object value,
    boolean detail) 

    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.

 protected  void appendNullText(StringBuffer buffer,
    String fieldName) 

    Append to the toString an indicator for null.

    The default indicator is '<null>'.

 public  void appendStart(StringBuffer buffer,
    Object object) 

    Append to the toString the start of data indicator.

 protected  void appendSummary(StringBuffer buffer,
    String fieldName,
    Object value) 

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

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

    Append to the toString a summary of an Object array.

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

    Append to the toString a summary of a long array.

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

    Append to the toString a summary of an int array.

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

    Append to the toString a summary of a short array.

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

    Append to the toString a summary of a byte array.

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

    Append to the toString a summary of a char array.

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

    Append to the toString a summary of a double array.

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

    Append to the toString a summary of a float array.

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

    Append to the toString a summary of a boolean array.

 protected  void appendSummarySize(StringBuffer buffer,
    String fieldName,
    int size) 

    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>'.

 public  void appendSuper(StringBuffer buffer,
    String superToString) 

    Append to the toString the superclass toString.

    NOTE: It assumes that the toString has been created from the same ToStringStyle.

    A null superToString is ignored.

 public  void appendToString(StringBuffer buffer,
    String toString) 

    Append to the toString another toString.

    NOTE: It assumes that the toString has been created from the same ToStringStyle.

    A null toString is ignored.

 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 getRegistry() 

    Returns 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.

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

 protected String getSizeEndText() 

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

    This is output after the size value.

 protected String getSizeStartText() 

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

    This is output before the size value.

 protected String getSummaryObjectEndText() 

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

    This is output after the size value.

 protected String getSummaryObjectStartText() 

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

    This is output before the size value.

 protected boolean isArrayContentDetail() 

    Gets whether to output array content detail.

 protected boolean isDefaultFullDetail() 

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

 protected boolean isFieldSeparatorAtEnd() 

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

 protected boolean isFieldSeparatorAtStart() 

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

 protected boolean isFullDetail(Boolean fullDetailRequest) 

    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.

 static boolean isRegistered(Object value) 

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

 protected boolean isShortClassName() 
Deprecated! Use - #isUseShortClassName() Method will be removed in Commons Lang 3.0.

    Gets whether to output short or long class names.

 protected boolean isUseClassName() 

    Gets whether to use the class name.

 protected boolean isUseFieldNames() 

    Gets whether to use the field names passed in.

 protected boolean isUseIdentityHashCode() 

    Gets whether to use the identity hash code.

 protected boolean isUseShortClassName() 

    Gets whether to output short or long class names.

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

    Append to the toString the detail of an array type.

 static  void register(Object value) 

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

 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.

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

 protected  void setArraySeparator(String arraySeparator) 

    Sets the array separator text.

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

 protected  void setArrayStart(String arrayStart) 

    Sets the array start text.

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

 protected  void setContentEnd(String contentEnd) 

    Sets the content end text.

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

 protected  void setContentStart(String contentStart) 

    Sets the content start text.

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

 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.

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

 protected  void setFieldSeparator(String fieldSeparator) 

    Sets the field separator text.

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

 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.

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

 protected  void setShortClassName(boolean shortClassName) 
Deprecated! Use - #setUseShortClassName(boolean) Method will be removed in Commons Lang 3.0.

    Sets whether to output short or long class names.

 protected  void setSizeEndText(String sizeEndText) 

    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.

 protected  void setSizeStartText(String sizeStartText) 

    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.

 protected  void setSummaryObjectEndText(String summaryObjectEndText) 

    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.

 protected  void setSummaryObjectStartText(String summaryObjectStartText) 

    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.

 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.

 static  void unregister(Object value) 

    Unregisters the given object.

    Used by the reflection methods to avoid infinite loops.