Save This Page
Home » commons-lang-2.4-src » org.apache.commons » lang » builder » [javadoc | source]
org.apache.commons.lang.builder
public class: StandardToStringStyle [javadoc | source]
java.lang.Object
   org.apache.commons.lang.builder.ToStringStyle
      org.apache.commons.lang.builder.StandardToStringStyle

All Implemented Interfaces:
    Serializable

Works with ToStringBuilder to create a toString.

This class is intended to be used as a singleton. There is no need to instantiate a new style each time. Simply instantiate the class once, customize the values as required, and store the result in a public static final variable for the rest of the program to access.

Fields inherited from org.apache.commons.lang.builder.ToStringStyle:
DEFAULT_STYLE,  MULTI_LINE_STYLE,  NO_FIELD_NAMES_STYLE,  SHORT_PREFIX_STYLE,  SIMPLE_STYLE
Constructor:
 public StandardToStringStyle() 
Method from org.apache.commons.lang.builder.StandardToStringStyle Summary:
getArrayEnd,   getArraySeparator,   getArrayStart,   getContentEnd,   getContentStart,   getFieldNameValueSeparator,   getFieldSeparator,   getNullText,   getSizeEndText,   getSizeStartText,   getSummaryObjectEndText,   getSummaryObjectStartText,   isArrayContentDetail,   isDefaultFullDetail,   isFieldSeparatorAtEnd,   isFieldSeparatorAtStart,   isShortClassName,   isUseClassName,   isUseFieldNames,   isUseIdentityHashCode,   isUseShortClassName,   setArrayContentDetail,   setArrayEnd,   setArraySeparator,   setArrayStart,   setContentEnd,   setContentStart,   setDefaultFullDetail,   setFieldNameValueSeparator,   setFieldSeparator,   setFieldSeparatorAtEnd,   setFieldSeparatorAtStart,   setNullText,   setShortClassName,   setSizeEndText,   setSizeStartText,   setSummaryObjectEndText,   setSummaryObjectStartText,   setUseClassName,   setUseFieldNames,   setUseIdentityHashCode,   setUseShortClassName
Methods from org.apache.commons.lang.builder.ToStringStyle:
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:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.commons.lang.builder.StandardToStringStyle Detail:
 public String getArrayEnd() 

    Gets the array end text.

 public String getArraySeparator() 

    Gets the array separator text.

 public String getArrayStart() 

    Gets the array start text.

 public String getContentEnd() 

    Gets the content end text.

 public String getContentStart() 

    Gets the content start text.

 public String getFieldNameValueSeparator() 

    Gets the field name value separator text.

 public String getFieldSeparator() 

    Gets the field separator text.

 public String getNullText() 

    Gets the text to output when null found.

 public String getSizeEndText() 
    Gets the end text to output when a Collection, Map or Array size is output.

    This is output after the size value.

 public String getSizeStartText() 

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

    This is output before the size value.

 public String getSummaryObjectEndText() 

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

    This is output after the size value.

 public String getSummaryObjectStartText() 

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

    This is output before the size value.

 public boolean isArrayContentDetail() 

    Gets whether to output array content detail.

 public boolean isDefaultFullDetail() 

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

 public boolean isFieldSeparatorAtEnd() 

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

 public boolean isFieldSeparatorAtStart() 

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

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

    Gets whether to output short or long class names.

 public boolean isUseClassName() 

    Gets whether to use the class name.

 public boolean isUseFieldNames() 

    Gets whether to use the field names passed in.

 public boolean isUseIdentityHashCode() 

    Gets whether to use the identity hash code.

 public boolean isUseShortClassName() 

    Gets whether to output short or long class names.

 public  void setArrayContentDetail(boolean arrayContentDetail) 

    Sets whether to output array content detail.

 public  void setArrayEnd(String arrayEnd) 

    Sets the array end text.

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

 public  void setArraySeparator(String arraySeparator) 

    Sets the array separator text.

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

 public  void setArrayStart(String arrayStart) 

    Sets the array start text.

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

 public  void setContentEnd(String contentEnd) 

    Sets the content end text.

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

 public  void setContentStart(String contentStart) 

    Sets the content start text.

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

 public  void setDefaultFullDetail(boolean defaultFullDetail) 

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

 public  void setFieldNameValueSeparator(String fieldNameValueSeparator) 

    Sets the field name value separator text.

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

 public  void setFieldSeparator(String fieldSeparator) 

    Sets the field separator text.

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

 public  void setFieldSeparatorAtEnd(boolean fieldSeparatorAtEnd) 

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

 public  void setFieldSeparatorAtStart(boolean fieldSeparatorAtStart) 

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

 public  void setNullText(String nullText) 

    Sets the text to output when null found.

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

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

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

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

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

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

 public  void setUseClassName(boolean useClassName) 

    Sets whether to use the class name.

 public  void setUseFieldNames(boolean useFieldNames) 

    Sets whether to use the field names passed in.

 public  void setUseIdentityHashCode(boolean useIdentityHashCode) 

    Sets whether to use the identity hash code.

 public  void setUseShortClassName(boolean useShortClassName) 

    Sets whether to output short or long class names.