Class StandardToStringStyle
- All Implemented Interfaces:
Serializable
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:
-
Field Summary
Fields inherited from class org.apache.commons.lang3.builder.ToStringStyle
DEFAULT_STYLE, JSON_STYLE, MULTI_LINE_STYLE, NO_CLASS_NAME_STYLE, NO_FIELD_NAMES_STYLE, SHORT_PREFIX_STYLE, SIMPLE_STYLE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets 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 whennullfound.Gets the end text to output when anObjectis output in summary mode.Gets the start text to output when anObjectis output in summary mode.booleanGets whether to output array content detail.booleanGets whether to use full detail when the caller doesn't specify.booleanGets whether the field separator should be added at the end of each buffer.booleanGets whether the field separator should be added at the start of each buffer.booleanGets whether to use the class name.booleanGets whether to use the field names passed in.booleanGets whether to use the identity hash code.booleanGets whether to output short or long class names.voidsetArrayContentDetail(boolean arrayContentDetail) Sets whether to output array content detail.voidsetArrayEnd(String arrayEnd) Sets the array end text.voidsetArraySeparator(String arraySeparator) Sets the array separator text.voidsetArrayStart(String arrayStart) Sets the array start text.voidsetContentEnd(String contentEnd) Sets the content end text.voidsetContentStart(String contentStart) Sets the content start text.voidsetDefaultFullDetail(boolean defaultFullDetail) Sets whether to use full detail when the caller doesn't specify.voidsetFieldNameValueSeparator(String fieldNameValueSeparator) Sets the field name value separator text.voidsetFieldSeparator(String fieldSeparator) Sets the field separator text.voidsetFieldSeparatorAtEnd(boolean fieldSeparatorAtEnd) Sets whether the field separator should be added at the end of each buffer.voidsetFieldSeparatorAtStart(boolean fieldSeparatorAtStart) Sets whether the field separator should be added at the start of each buffer.voidsetNullText(String nullText) Sets the text to output whennullfound.voidsetSizeEndText(String sizeEndText) voidsetSizeStartText(String sizeStartText) voidsetSummaryObjectEndText(String summaryObjectEndText) Sets the end text to output when anObjectis output in summary mode.voidsetSummaryObjectStartText(String summaryObjectStartText) Sets the start text to output when anObjectis output in summary mode.voidsetUseClassName(boolean useClassName) Sets whether to use the class name.voidsetUseFieldNames(boolean useFieldNames) Sets whether to use the field names passed in.voidsetUseIdentityHashCode(boolean useIdentityHashCode) Sets whether to use the identity hash code.voidsetUseShortClassName(boolean useShortClassName) Sets whether to output short or long class names.Methods inherited from class org.apache.commons.lang3.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, appendDetail, appendEnd, appendFieldEnd, appendFieldSeparator, appendFieldStart, appendIdentityHashCode, appendInternal, appendNullText, appendStart, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummarySize, appendSuper, appendToString, getRegistry, getShortClassName, isFullDetail, reflectionAppendArrayDetail, removeLastFieldSeparator
-
Constructor Details
-
StandardToStringStyle
public StandardToStringStyle()Constructs a new instance.
-
-
Method Details
-
getArrayEnd
Gets the array end text.- Overrides:
getArrayEndin classToStringStyle- Returns:
- the current array end text
-
getArraySeparator
Gets the array separator text.- Overrides:
getArraySeparatorin classToStringStyle- Returns:
- the current array separator text
-
getArrayStart
Gets the array start text.- Overrides:
getArrayStartin classToStringStyle- Returns:
- the current array start text
-
getContentEnd
Gets the content end text.- Overrides:
getContentEndin classToStringStyle- Returns:
- the current content end text
-
getContentStart
Gets the content start text.- Overrides:
getContentStartin classToStringStyle- Returns:
- the current content start text
-
getFieldNameValueSeparator
Gets the field name value separator text.- Overrides:
getFieldNameValueSeparatorin classToStringStyle- Returns:
- the current field name value separator text
-
getFieldSeparator
Gets the field separator text.- Overrides:
getFieldSeparatorin classToStringStyle- Returns:
- the current field separator text
-
getNullText
Gets the text to output whennullfound.- Overrides:
getNullTextin classToStringStyle- Returns:
- the current text to output when
nullfound
-
getSizeEndText
Gets the end text to output when aCollection,MaporArraysize is output.This is output after the size value.
- Overrides:
getSizeEndTextin classToStringStyle- Returns:
- the current end of size text
-
getSizeStartText
Gets the text to output when aCollection,MaporArraysize is output.This is output before the size value.
- Overrides:
getSizeStartTextin classToStringStyle- Returns:
- the current start of size text
-
getSummaryObjectEndText
Gets the end text to output when anObjectis output in summary mode.This is output after the size value.
- Overrides:
getSummaryObjectEndTextin classToStringStyle- Returns:
- the current end of summary text
-
getSummaryObjectStartText
Gets the start text to output when anObjectis output in summary mode.This is output before the size value.
- Overrides:
getSummaryObjectStartTextin classToStringStyle- Returns:
- the current start of summary text
-
isArrayContentDetail
Gets whether to output array content detail.- Overrides:
isArrayContentDetailin classToStringStyle- Returns:
- the current array content detail setting
-
isDefaultFullDetail
Gets whether to use full detail when the caller doesn't specify.- Overrides:
isDefaultFullDetailin classToStringStyle- Returns:
- the current defaultFullDetail flag
-
isFieldSeparatorAtEnd
Gets whether the field separator should be added at the end of each buffer.- Overrides:
isFieldSeparatorAtEndin classToStringStyle- Returns:
- fieldSeparatorAtEnd flag
- Since:
- 2.0
-
isFieldSeparatorAtStart
Gets whether the field separator should be added at the start of each buffer.- Overrides:
isFieldSeparatorAtStartin classToStringStyle- Returns:
- the fieldSeparatorAtStart flag
- Since:
- 2.0
-
isUseClassName
Gets whether to use the class name.- Overrides:
isUseClassNamein classToStringStyle- Returns:
- the current useClassName flag
-
isUseFieldNames
Gets whether to use the field names passed in.- Overrides:
isUseFieldNamesin classToStringStyle- Returns:
- the current useFieldNames flag
-
isUseIdentityHashCode
Gets whether to use the identity hash code.- Overrides:
isUseIdentityHashCodein classToStringStyle- Returns:
- the current useIdentityHashCode flag
-
isUseShortClassName
Gets whether to output short or long class names.- Overrides:
isUseShortClassNamein classToStringStyle- Returns:
- the current useShortClassName flag
- Since:
- 2.0
-
setArrayContentDetail
Sets whether to output array content detail.- Overrides:
setArrayContentDetailin classToStringStyle- Parameters:
arrayContentDetail- the new arrayContentDetail flag
-
setArrayEnd
Sets the array end text.nullis accepted, but will be converted to an empty String.- Overrides:
setArrayEndin classToStringStyle- Parameters:
arrayEnd- the new array end text
-
setArraySeparator
Sets the array separator text.nullis accepted, but will be converted to an empty String.- Overrides:
setArraySeparatorin classToStringStyle- Parameters:
arraySeparator- the new array separator text
-
setArrayStart
Sets the array start text.nullis accepted, but will be converted to an empty String.- Overrides:
setArrayStartin classToStringStyle- Parameters:
arrayStart- the new array start text
-
setContentEnd
Sets the content end text.nullis accepted, but will be converted to an empty String.- Overrides:
setContentEndin classToStringStyle- Parameters:
contentEnd- the new content end text
-
setContentStart
Sets the content start text.nullis accepted, but will be converted to an empty String.- Overrides:
setContentStartin classToStringStyle- Parameters:
contentStart- the new content start text
-
setDefaultFullDetail
Sets whether to use full detail when the caller doesn't specify.- Overrides:
setDefaultFullDetailin classToStringStyle- Parameters:
defaultFullDetail- the new defaultFullDetail flag
-
setFieldNameValueSeparator
Sets the field name value separator text.nullis accepted, but will be converted to an empty String.- Overrides:
setFieldNameValueSeparatorin classToStringStyle- Parameters:
fieldNameValueSeparator- the new field name value separator text
-
setFieldSeparator
Sets the field separator text.nullis accepted, but will be converted to an empty String.- Overrides:
setFieldSeparatorin classToStringStyle- Parameters:
fieldSeparator- the new field separator text
-
setFieldSeparatorAtEnd
Sets whether the field separator should be added at the end of each buffer.- Overrides:
setFieldSeparatorAtEndin classToStringStyle- Parameters:
fieldSeparatorAtEnd- the fieldSeparatorAtEnd flag- Since:
- 2.0
-
setFieldSeparatorAtStart
Sets whether the field separator should be added at the start of each buffer.- Overrides:
setFieldSeparatorAtStartin classToStringStyle- Parameters:
fieldSeparatorAtStart- the fieldSeparatorAtStart flag- Since:
- 2.0
-
setNullText
Sets the text to output whennullfound.nullis accepted, but will be converted to an empty String.- Overrides:
setNullTextin classToStringStyle- Parameters:
nullText- the new text to output whennullfound
-
setSizeEndText
Sets the end text to output when aCollection,MaporArraysize is output.This is output after the size value.
nullis accepted, but will be converted to an empty String.- Overrides:
setSizeEndTextin classToStringStyle- Parameters:
sizeEndText- the new end of size text
-
setSizeStartText
Sets the start text to output when aCollection,MaporArraysize is output.This is output before the size value.
nullis accepted, but will be converted to an empty String.- Overrides:
setSizeStartTextin classToStringStyle- Parameters:
sizeStartText- the new start of size text
-
setSummaryObjectEndText
Sets the end text to output when anObjectis output in summary mode.This is output after the size value.
nullis accepted, but will be converted to an empty String.- Overrides:
setSummaryObjectEndTextin classToStringStyle- Parameters:
summaryObjectEndText- the new end of summary text
-
setSummaryObjectStartText
Sets the start text to output when anObjectis output in summary mode.This is output before the size value.
nullis accepted, but will be converted to an empty String.- Overrides:
setSummaryObjectStartTextin classToStringStyle- Parameters:
summaryObjectStartText- the new start of summary text
-
setUseClassName
Sets whether to use the class name.- Overrides:
setUseClassNamein classToStringStyle- Parameters:
useClassName- the new useClassName flag
-
setUseFieldNames
Sets whether to use the field names passed in.- Overrides:
setUseFieldNamesin classToStringStyle- Parameters:
useFieldNames- the new useFieldNames flag
-
setUseIdentityHashCode
Sets whether to use the identity hash code.- Overrides:
setUseIdentityHashCodein classToStringStyle- Parameters:
useIdentityHashCode- the new useIdentityHashCode flag
-
setUseShortClassName
Sets whether to output short or long class names.- Overrides:
setUseShortClassNamein classToStringStyle- Parameters:
useShortClassName- the new useShortClassName flag- Since:
- 2.0
-