Package org.apache.commons.lang3.builder

Class StandardToStringStyle

java.lang.Object
org.apache.commons.lang3.builder.ToStringStyle
org.apache.commons.lang3.builder.StandardToStringStyle
All Implemented Interfaces:
Serializable
public class StandardToStringStyle extends ToStringStyle
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.

Since:
1.0
See Also:

  • Constructor Details

    • StandardToStringStyle

      public StandardToStringStyle()
      Constructor.

  • Method Details

    • getArrayEnd

      public String getArrayEnd()
      Gets the array end text.
      Returns:
      the current array end text

    • getArraySeparator

      public String getArraySeparator()
      Gets the array separator text.
      Returns:
      the current array separator text

    • getArrayStart

      public String getArrayStart()
      Gets the array start text.
      Returns:
      the current array start text

    • getContentEnd

      public String getContentEnd()
      Gets the content end text.
      Returns:
      the current content end text

    • getContentStart

      public String getContentStart()
      Gets the content start text.
      Returns:
      the current content start text

    • getFieldNameValueSeparator

      public String getFieldNameValueSeparator()
      Gets the field name value separator text.
      Returns:
      the current field name value separator text

    • getFieldSeparator

      public String getFieldSeparator()
      Gets the field separator text.
      Returns:
      the current field separator text

    • getNullText

      public String getNullText()
      Gets the text to output when null found.
      Returns:
      the current text to output when null found

    • getSizeEndText

      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.

      Returns:
      the current end of size text

    • getSizeStartText

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

      This is output before the size value.

      Returns:
      the current start of size text

    • getSummaryObjectEndText

      public String getSummaryObjectEndText()
      Gets the end text to output when an Object is output in summary mode.

      This is output after the size value.

      Returns:
      the current end of summary text

    • getSummaryObjectStartText

      public String getSummaryObjectStartText()
      Gets the start text to output when an Object is output in summary mode.

      This is output before the size value.

      Returns:
      the current start of summary text

    • isArrayContentDetail

      public boolean isArrayContentDetail()
      Gets whether to output array content detail.
      Returns:
      the current array content detail setting

    • isDefaultFullDetail

      public boolean isDefaultFullDetail()
      Gets whether to use full detail when the caller doesn't specify.
      Returns:
      the current defaultFullDetail flag

    • isFieldSeparatorAtEnd

      public boolean isFieldSeparatorAtEnd()
      Gets whether the field separator should be added at the end of each buffer.
      Returns:
      fieldSeparatorAtEnd flag
      Since:
      2.0

    • isFieldSeparatorAtStart

      public boolean isFieldSeparatorAtStart()
      Gets whether the field separator should be added at the start of each buffer.
      Returns:
      the fieldSeparatorAtStart flag
      Since:
      2.0

    • isUseClassName

      public boolean isUseClassName()
      Gets whether to use the class name.
      Returns:
      the current useClassName flag

    • isUseFieldNames

      public boolean isUseFieldNames()
      Gets whether to use the field names passed in.
      Returns:
      the current useFieldNames flag

    • isUseIdentityHashCode

      public boolean isUseIdentityHashCode()
      Gets whether to use the identity hash code.
      Returns:
      the current useIdentityHashCode flag

    • isUseShortClassName

      public boolean isUseShortClassName()
      Gets whether to output short or long class names.
      Returns:
      the current useShortClassName flag
      Since:
      2.0

    • setArrayContentDetail

      public void setArrayContentDetail(boolean arrayContentDetail)
      Sets whether to output array content detail.
      Parameters:
      arrayContentDetail - the new arrayContentDetail flag

    • setArrayEnd

      public void setArrayEnd(String arrayEnd)
      Sets the array end text.

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

      Parameters:
      arrayEnd - the new array end text

    • setArraySeparator

      public void setArraySeparator(String arraySeparator)
      Sets the array separator text.

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

      Parameters:
      arraySeparator - the new array separator text

    • setArrayStart

      public void setArrayStart(String arrayStart)
      Sets the array start text.

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

      Parameters:
      arrayStart - the new array start text

    • setContentEnd

      public void setContentEnd(String contentEnd)
      Sets the content end text.

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

      Parameters:
      contentEnd - the new content end text

    • setContentStart

      public void setContentStart(String contentStart)
      Sets the content start text.

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

      Parameters:
      contentStart - the new content start text

    • setDefaultFullDetail

      public void setDefaultFullDetail(boolean defaultFullDetail)
      Sets whether to use full detail when the caller doesn't specify.
      Parameters:
      defaultFullDetail - the new defaultFullDetail flag

    • setFieldNameValueSeparator

      public void setFieldNameValueSeparator(String fieldNameValueSeparator)
      Sets the field name value separator text.

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

      Parameters:
      fieldNameValueSeparator - the new field name value separator text

    • setFieldSeparator

      public void setFieldSeparator(String fieldSeparator)
      Sets the field separator text.

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

      Parameters:
      fieldSeparator - the new field separator text

    • setFieldSeparatorAtEnd

      public void setFieldSeparatorAtEnd(boolean fieldSeparatorAtEnd)
      Sets whether the field separator should be added at the end of each buffer.
      Parameters:
      fieldSeparatorAtEnd - the fieldSeparatorAtEnd flag
      Since:
      2.0

    • setFieldSeparatorAtStart

      public void setFieldSeparatorAtStart(boolean fieldSeparatorAtStart)
      Sets whether the field separator should be added at the start of each buffer.
      Parameters:
      fieldSeparatorAtStart - the fieldSeparatorAtStart flag
      Since:
      2.0

    • setNullText

      public void setNullText(String nullText)
      Sets the text to output when null found.

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

      Parameters:
      nullText - the new text to output when null found

    • setSizeEndText

      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.

      Parameters:
      sizeEndText - the new end of size text

    • setSizeStartText

      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.

      Parameters:
      sizeStartText - the new start of size text

    • setSummaryObjectEndText

      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.

      Parameters:
      summaryObjectEndText - the new end of summary text

    • setSummaryObjectStartText

      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.

      Parameters:
      summaryObjectStartText - the new start of summary text

    • setUseClassName

      public void setUseClassName(boolean useClassName)
      Sets whether to use the class name.
      Parameters:
      useClassName - the new useClassName flag

    • setUseFieldNames

      public void setUseFieldNames(boolean useFieldNames)
      Sets whether to use the field names passed in.
      Parameters:
      useFieldNames - the new useFieldNames flag

    • setUseIdentityHashCode

      public void setUseIdentityHashCode(boolean useIdentityHashCode)
      Sets whether to use the identity hash code.
      Parameters:
      useIdentityHashCode - the new useIdentityHashCode flag

    • setUseShortClassName

      public void setUseShortClassName(boolean useShortClassName)
      Sets whether to output short or long class names.
      Parameters:
      useShortClassName - the new useShortClassName flag
      Since:
      2.0