org.apache.commons.lang.builder
クラス StandardToStringStyle

java.lang.Object
  org.apache.commons.lang.builder.ToStringStyle
      org.apache.commons.lang.builder.StandardToStringStyle

すべての実装インタフェース:

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.

導入されたバージョン:

1.0

バージョン:

$Id: StandardToStringStyle.java,v 1.1.1.1 2004/02/13 10:02:06 hioki Exp $

作成者:

Stephen Colebourne, Pete Gieser, Gary Gregory

関連項目:

直列化された形式

フィールドの概要

クラス org.apache.commons.lang.builder.ToStringStyle から継承したフィールド

DEFAULT_STYLE, MULTI_LINE_STYLE, NO_FIELD_NAMES_STYLE, SIMPLE_STYLE

コンストラクタの概要

StandardToStringStyle()
Constructor.

メソッドの概要

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() 推奨されていません。 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) 推奨されていません。 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.

クラス 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, getShortClassName, isFullDetail, reflectionAppendArrayDetail, removeLastFieldSeparator

クラス java.lang.Object から継承したメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

StandardToStringStyle

public StandardToStringStyle()

Constructor.

メソッドの詳細

isUseClassName

public boolean isUseClassName()

Gets whether to use the class name.

オーバーライド:

クラス ToStringStyle 内の isUseClassName

戻り値:

the current useClassName flag

setUseClassName

public void setUseClassName(boolean useClassName)

Sets whether to use the class name.

オーバーライド:

クラス ToStringStyle 内の setUseClassName

パラメータ:

useClassName - the new useClassName flag

isUseShortClassName

public boolean isUseShortClassName()

Gets whether to output short or long class names.

オーバーライド:

クラス ToStringStyle 内の isUseShortClassName

戻り値:

the current useShortClassName flag

導入されたバージョン:

2.0

isShortClassName

public boolean isShortClassName()

推奨されていません。 Use isUseShortClassName() Method will be removed in Commons Lang 3.0.

Gets whether to output short or long class names.

オーバーライド:

クラス ToStringStyle 内の isShortClassName

戻り値:

the current shortClassName flag

setUseShortClassName

public void setUseShortClassName(boolean useShortClassName)

Sets whether to output short or long class names.

オーバーライド:

クラス ToStringStyle 内の setUseShortClassName

パラメータ:

useShortClassName - the new useShortClassName flag

導入されたバージョン:

2.0

setShortClassName

public void setShortClassName(boolean shortClassName)

推奨されていません。 Use setUseShortClassName(boolean) Method will be removed in Commons Lang 3.0.

Sets whether to output short or long class names.

オーバーライド:

クラス ToStringStyle 内の setShortClassName

パラメータ:

shortClassName - the new shortClassName flag

isUseIdentityHashCode

public boolean isUseIdentityHashCode()

Gets whether to use the identity hash code.

オーバーライド:

クラス ToStringStyle 内の isUseIdentityHashCode

戻り値:

the current useIdentityHashCode flag

setUseIdentityHashCode

public void setUseIdentityHashCode(boolean useIdentityHashCode)

Sets whether to use the identity hash code.

オーバーライド:

クラス ToStringStyle 内の setUseIdentityHashCode

パラメータ:

useIdentityHashCode - the new useIdentityHashCode flag

isUseFieldNames

public boolean isUseFieldNames()

Gets whether to use the field names passed in.

オーバーライド:

クラス ToStringStyle 内の isUseFieldNames

戻り値:

the current useFieldNames flag

setUseFieldNames

public void setUseFieldNames(boolean useFieldNames)

Sets whether to use the field names passed in.

オーバーライド:

クラス ToStringStyle 内の setUseFieldNames

パラメータ:

useFieldNames - the new useFieldNames flag

isDefaultFullDetail

public boolean isDefaultFullDetail()

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

オーバーライド:

クラス ToStringStyle 内の isDefaultFullDetail

戻り値:

the current defaultFullDetail flag

setDefaultFullDetail

public void setDefaultFullDetail(boolean defaultFullDetail)

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

オーバーライド:

クラス ToStringStyle 内の setDefaultFullDetail

パラメータ:

defaultFullDetail - the new defaultFullDetail flag

isArrayContentDetail

public boolean isArrayContentDetail()

Gets whether to output array content detail.

オーバーライド:

クラス ToStringStyle 内の isArrayContentDetail

戻り値:

the current array content detail setting

setArrayContentDetail

public void setArrayContentDetail(boolean arrayContentDetail)

Sets whether to output array content detail.

オーバーライド:

クラス ToStringStyle 内の setArrayContentDetail

パラメータ:

arrayContentDetail - the new arrayContentDetail flag

getArrayStart

public String getArrayStart()

Gets the array start text.

オーバーライド:

クラス ToStringStyle 内の getArrayStart

戻り値:

the current array start text

setArrayStart

public void setArrayStart(String arrayStart)

Sets the array start text.

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

オーバーライド:

クラス ToStringStyle 内の setArrayStart

パラメータ:

arrayStart - the new array start text

getArrayEnd

public String getArrayEnd()

Gets the array end text.

オーバーライド:

クラス ToStringStyle 内の getArrayEnd

戻り値:

the current array end text

setArrayEnd

public void setArrayEnd(String arrayEnd)

Sets the array end text.

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

オーバーライド:

クラス ToStringStyle 内の setArrayEnd

パラメータ:

arrayEnd - the new array end text

getArraySeparator

public String getArraySeparator()

Gets the array separator text.

オーバーライド:

クラス ToStringStyle 内の getArraySeparator

戻り値:

the current array separator text

setArraySeparator

public void setArraySeparator(String arraySeparator)

Sets the array separator text.

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

オーバーライド:

クラス ToStringStyle 内の setArraySeparator

パラメータ:

arraySeparator - the new array separator text

getContentStart

public String getContentStart()

Gets the content start text.

オーバーライド:

クラス ToStringStyle 内の getContentStart

戻り値:

the current content start text

setContentStart

public void setContentStart(String contentStart)

Sets the content start text.

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

オーバーライド:

クラス ToStringStyle 内の setContentStart

パラメータ:

contentStart - the new content start text

getContentEnd

public String getContentEnd()

Gets the content end text.

オーバーライド:

クラス ToStringStyle 内の getContentEnd

戻り値:

the current content end text

setContentEnd

public void setContentEnd(String contentEnd)

Sets the content end text.

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

オーバーライド:

クラス ToStringStyle 内の setContentEnd

パラメータ:

contentEnd - the new content end text

getFieldNameValueSeparator

public String getFieldNameValueSeparator()

Gets the field name value separator text.

オーバーライド:

クラス ToStringStyle 内の getFieldNameValueSeparator

戻り値:

the current field name value separator text

setFieldNameValueSeparator

public void setFieldNameValueSeparator(String fieldNameValueSeparator)

Sets the field name value separator text.

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

オーバーライド:

クラス ToStringStyle 内の setFieldNameValueSeparator

パラメータ:

fieldNameValueSeparator - the new field name value separator text

getFieldSeparator

public String getFieldSeparator()

Gets the field separator text.

オーバーライド:

クラス ToStringStyle 内の getFieldSeparator

戻り値:

the current field separator text

setFieldSeparator

public void setFieldSeparator(String fieldSeparator)

Sets the field separator text.

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

オーバーライド:

クラス ToStringStyle 内の setFieldSeparator

パラメータ:

fieldSeparator - the new field separator text

isFieldSeparatorAtStart

public boolean isFieldSeparatorAtStart()

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

オーバーライド:

クラス ToStringStyle 内の isFieldSeparatorAtStart

戻り値:

the fieldSeparatorAtStart flag

導入されたバージョン:

2.0

setFieldSeparatorAtStart

public void setFieldSeparatorAtStart(boolean fieldSeparatorAtStart)

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

オーバーライド:

クラス ToStringStyle 内の setFieldSeparatorAtStart

パラメータ:

fieldSeparatorAtStart - the fieldSeparatorAtStart flag

導入されたバージョン:

2.0

isFieldSeparatorAtEnd

public boolean isFieldSeparatorAtEnd()

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

オーバーライド:

クラス ToStringStyle 内の isFieldSeparatorAtEnd

戻り値:

fieldSeparatorAtEnd flag

導入されたバージョン:

2.0

setFieldSeparatorAtEnd

public void setFieldSeparatorAtEnd(boolean fieldSeparatorAtEnd)

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

オーバーライド:

クラス ToStringStyle 内の setFieldSeparatorAtEnd

パラメータ:

fieldSeparatorAtEnd - the fieldSeparatorAtEnd flag

導入されたバージョン:

2.0

getNullText

public String getNullText()

Gets the text to output when null found.

オーバーライド:

クラス ToStringStyle 内の getNullText

戻り値:

the current text to output when null found

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.

オーバーライド:

クラス ToStringStyle 内の setNullText

パラメータ:

nullText - the new text to output when null found

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.

オーバーライド:

クラス ToStringStyle 内の getSizeStartText

戻り値:

the current start 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.

オーバーライド:

クラス ToStringStyle 内の setSizeStartText

パラメータ:

sizeStartText - the new start of size text

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.

オーバーライド:

クラス ToStringStyle 内の getSizeEndText

戻り値:

the current end of size text

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.

オーバーライド:

クラス ToStringStyle 内の setSizeEndText

パラメータ:

sizeEndText - the new end of size 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.

オーバーライド:

クラス ToStringStyle 内の getSummaryObjectStartText

戻り値:

the current start 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.

オーバーライド:

クラス ToStringStyle 内の setSummaryObjectStartText

パラメータ:

summaryObjectStartText - the new start of summary 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.

オーバーライド:

クラス ToStringStyle 内の getSummaryObjectEndText

戻り値:

the current end of summary 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.

オーバーライド:

クラス ToStringStyle 内の setSummaryObjectEndText

パラメータ:

summaryObjectEndText - the new end of summary text