org.apache.commons.lang.builder

Class StandardToStringStyle

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.

Version:
$Id: StandardToStringStyle.java,v 1.16 2003/08/23 00:22:53 ggregory Exp $

Authors:
Stephen Colebourne
Pete Gieser
Gary Gregory

Since:
1.0

Field Summary

Fields inherited from class org.apache.commons.lang.builder.ToStringStyle

DEFAULT_STYLE, MULTI_LINE_STYLE, NO_FIELD_NAMES_STYLE, SIMPLE_STYLE

Constructor Summary

StandardToStringStyle()
Constructor.

Method Summary

String
getArrayEnd()
Gets the array end text.
String
getArraySeparator()
Gets the array separator text.
String
getArrayStart()
Gets the array start text.
String
getContentEnd()
Gets the content end text.
String
getContentStart()
Gets the content start text.
String
getFieldNameValueSeparator()
Gets the field name value separator text.
String
getFieldSeparator()
Gets the field separator text.
String
getNullText()
Gets the text to output when null found.
String
getSizeEndText()
Gets the end text to output when a Collection, Map or Array size is output.
String
getSizeStartText()
Gets the text to output when a Collection, Map or Array size is output.
String
getSummaryObjectEndText()
Gets the end text to output when an Object is output in summary mode.
String
getSummaryObjectStartText()
Gets the start text to output when an Object is output in summary mode.
boolean
isArrayContentDetail()
Gets whether to output array content detail.
boolean
isDefaultFullDetail()
Gets whether to use full detail when the caller doesn't specify.
boolean
isFieldSeparatorAtEnd()
Gets whether the field separator should be added at the end of each buffer.
boolean
isFieldSeparatorAtStart()
Gets whether the field separator should be added at the start of each buffer.
boolean
isShortClassName()
Deprecated. Use isUseShortClassName() Method will be removed in Commons Lang 3.0.
boolean
isUseClassName()
Gets whether to use the class name.
boolean
isUseFieldNames()
Gets whether to use the field names passed in.
boolean
isUseIdentityHashCode()
Gets whether to use the identity hash code.
boolean
isUseShortClassName()
Gets whether to output short or long class names.
void
setArrayContentDetail(boolean arrayContentDetail)
Sets whether to output array content detail.
void
setArrayEnd(String arrayEnd)
Sets the array end text.
void
setArraySeparator(String arraySeparator)
Sets the array separator text.
void
setArrayStart(String arrayStart)
Sets the array start text.
void
setContentEnd(String contentEnd)
Sets the content end text.
void
setContentStart(String contentStart)
Sets the content start text.
void
setDefaultFullDetail(boolean defaultFullDetail)
Sets whether to use full detail when the caller doesn't specify.
void
setFieldNameValueSeparator(String fieldNameValueSeparator)
Sets the field name value separator text.
void
setFieldSeparator(String fieldSeparator)
Sets the field separator text.
void
setFieldSeparatorAtEnd(boolean fieldSeparatorAtEnd)
Sets whether the field separator should be added at the end of each buffer.
void
setFieldSeparatorAtStart(boolean fieldSeparatorAtStart)
Sets whether the field separator should be added at the start of each buffer.
void
setNullText(String nullText)
Sets the text to output when null found.
void
setShortClassName(boolean shortClassName)
Deprecated. Use setUseShortClassName(boolean) Method will be removed in Commons Lang 3.0.
void
setSizeEndText(String sizeEndText)
Sets the end text to output when a Collection, Map or Array size is output.
void
setSizeStartText(String sizeStartText)
Sets the start text to output when a Collection, Map or Array size is output.
void
setSummaryObjectEndText(String summaryObjectEndText)
Sets the end text to output when an Object is output in summary mode.
void
setSummaryObjectStartText(String summaryObjectStartText)
Sets the start text to output when an Object is output in summary mode.
void
setUseClassName(boolean useClassName)
Sets whether to use the class name.
void
setUseFieldNames(boolean useFieldNames)
Sets whether to use the field names passed in.
void
setUseIdentityHashCode(boolean useIdentityHashCode)
Sets whether to use the identity hash code.
void
setUseShortClassName(boolean useShortClassName)
Sets whether to output short or long class names.

Methods inherited from class 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, 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, getShortClassName, getSizeEndText, getSizeStartText, getSummaryObjectEndText, getSummaryObjectStartText, isArrayContentDetail, isDefaultFullDetail, isFieldSeparatorAtEnd, isFieldSeparatorAtStart, isFullDetail, isShortClassName, isUseClassName, isUseFieldNames, isUseIdentityHashCode, isUseShortClassName, reflectionAppendArrayDetail, removeLastFieldSeparator, setArrayContentDetail, setArrayEnd, setArraySeparator, setArrayStart, setContentEnd, setContentStart, setDefaultFullDetail, setFieldNameValueSeparator, setFieldSeparator, setFieldSeparatorAtEnd, setFieldSeparatorAtStart, setNullText, setShortClassName, setSizeEndText, setSizeStartText, setSummaryObjectEndText, setSummaryObjectStartText, setUseClassName, setUseFieldNames, setUseIdentityHashCode, setUseShortClassName

Constructor Details

StandardToStringStyle

public StandardToStringStyle()
Constructor.

Method Details

getArrayEnd

public String getArrayEnd()
Gets the array end text.
Overrides:
getArrayEnd in interface ToStringStyle

Returns:
the current array end text


getArraySeparator

public String getArraySeparator()
Gets the array separator text.
Overrides:
getArraySeparator in interface ToStringStyle

Returns:
the current array separator text


getArrayStart

public String getArrayStart()
Gets the array start text.
Overrides:
getArrayStart in interface ToStringStyle

Returns:
the current array start text


getContentEnd

public String getContentEnd()
Gets the content end text.
Overrides:
getContentEnd in interface ToStringStyle

Returns:
the current content end text


getContentStart

public String getContentStart()
Gets the content start text.
Overrides:
getContentStart in interface ToStringStyle

Returns:
the current content start text


getFieldNameValueSeparator

public String getFieldNameValueSeparator()
Gets the field name value separator text.
Overrides:
getFieldNameValueSeparator in interface ToStringStyle

Returns:
the current field name value separator text


getFieldSeparator

public String getFieldSeparator()
Gets the field separator text.
Overrides:
getFieldSeparator in interface ToStringStyle

Returns:
the current field separator text


getNullText

public String getNullText()
Gets the text to output when null found.
Overrides:
getNullText in interface ToStringStyle

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.

Overrides:
getSizeEndText in interface ToStringStyle

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.

Overrides:
getSizeStartText in interface ToStringStyle

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.

Overrides:
getSummaryObjectEndText in interface ToStringStyle

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.

Overrides:
getSummaryObjectStartText in interface ToStringStyle

Returns:
the current start of summary text


isArrayContentDetail

public boolean isArrayContentDetail()
Gets whether to output array content detail.
Overrides:
isArrayContentDetail in interface ToStringStyle

Returns:
the current array content detail setting


isDefaultFullDetail

public boolean isDefaultFullDetail()
Gets whether to use full detail when the caller doesn't specify.
Overrides:
isDefaultFullDetail in interface ToStringStyle

Returns:
the current defaultFullDetail flag


isFieldSeparatorAtEnd

public boolean isFieldSeparatorAtEnd()
Gets whether the field separator should be added at the end of each buffer.
Overrides:
isFieldSeparatorAtEnd in interface ToStringStyle

Returns:
fieldSeparatorAtEnd flag

Since:
2.0


isFieldSeparatorAtStart

public boolean isFieldSeparatorAtStart()
Gets whether the field separator should be added at the start of each buffer.
Overrides:
isFieldSeparatorAtStart in interface ToStringStyle

Returns:
the fieldSeparatorAtStart flag

Since:
2.0


isShortClassName

public boolean isShortClassName()

Deprecated. Use isUseShortClassName() Method will be removed in Commons Lang 3.0.

Gets whether to output short or long class names.
Overrides:
isShortClassName in interface ToStringStyle

Returns:
the current shortClassName flag


isUseClassName

public boolean isUseClassName()
Gets whether to use the class name.
Overrides:
isUseClassName in interface ToStringStyle

Returns:
the current useClassName flag


isUseFieldNames

public boolean isUseFieldNames()
Gets whether to use the field names passed in.
Overrides:
isUseFieldNames in interface ToStringStyle

Returns:
the current useFieldNames flag


isUseIdentityHashCode

public boolean isUseIdentityHashCode()
Gets whether to use the identity hash code.
Overrides:
isUseIdentityHashCode in interface ToStringStyle

Returns:
the current useIdentityHashCode flag


isUseShortClassName

public boolean isUseShortClassName()
Gets whether to output short or long class names.
Overrides:
isUseShortClassName in interface ToStringStyle

Returns:
the current useShortClassName flag

Since:
2.0


setArrayContentDetail

public void setArrayContentDetail(boolean arrayContentDetail)
Sets whether to output array content detail.
Overrides:
setArrayContentDetail in interface ToStringStyle

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.

Overrides:
setArrayEnd in interface ToStringStyle

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.

Overrides:
setArraySeparator in interface ToStringStyle

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.

Overrides:
setArrayStart in interface ToStringStyle

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.

Overrides:
setContentEnd in interface ToStringStyle

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.

Overrides:
setContentStart in interface ToStringStyle

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.
Overrides:
setDefaultFullDetail in interface ToStringStyle

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.

Overrides:
setFieldNameValueSeparator in interface ToStringStyle

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.

Overrides:
setFieldSeparator in interface ToStringStyle

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.
Overrides:
setFieldSeparatorAtEnd in interface ToStringStyle

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.
Overrides:
setFieldSeparatorAtStart in interface ToStringStyle

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.

Overrides:
setNullText in interface ToStringStyle

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


setShortClassName

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.
Overrides:
setShortClassName in interface ToStringStyle

Parameters:
shortClassName - the new shortClassName flag


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.

Overrides:
setSizeEndText in interface ToStringStyle

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.

Overrides:
setSizeStartText in interface ToStringStyle

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.

Overrides:
setSummaryObjectEndText in interface ToStringStyle

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.

Overrides:
setSummaryObjectStartText in interface ToStringStyle

Parameters:
summaryObjectStartText - the new start of summary text


setUseClassName

public void setUseClassName(boolean useClassName)
Sets whether to use the class name.
Overrides:
setUseClassName in interface ToStringStyle

Parameters:
useClassName - the new useClassName flag


setUseFieldNames

public void setUseFieldNames(boolean useFieldNames)
Sets whether to use the field names passed in.
Overrides:
setUseFieldNames in interface ToStringStyle

Parameters:
useFieldNames - the new useFieldNames flag


setUseIdentityHashCode

public void setUseIdentityHashCode(boolean useIdentityHashCode)
Sets whether to use the identity hash code.
Overrides:
setUseIdentityHashCode in interface ToStringStyle

Parameters:
useIdentityHashCode - the new useIdentityHashCode flag


setUseShortClassName

public void setUseShortClassName(boolean useShortClassName)
Sets whether to output short or long class names.
Overrides:
setUseShortClassName in interface ToStringStyle

Parameters:
useShortClassName - the new useShortClassName flag

Since:
2.0


Copyright © 2001-2003 - Apache Software Foundation