Class ToStringStyle
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
RecursiveToStringStyle,StandardToStringStyle
String formatting for ToStringBuilder.
The main public interface is always via ToStringBuilder.
These classes are intended to be used as singletons.
There is no need to instantiate a new style each time. A program
will generally use one of the predefined constants on this class.
Alternatively, the StandardToStringStyle class can be used
to set the individual settings. Thus most styles can be achieved
without subclassing.
If required, a subclass can override as many or as few of the
methods as it requires. Each object type (from boolean
to long to Object to int[]) has
its own methods to output it. Most have two versions, detail and summary.
For example, the detail version of the array based methods will output the whole array, whereas the summary method will just output the array length.
If you want to format the output of certain objects, such as dates, you must create a subclass and override a method.
public class MyStyle extends ToStringStyle {
protected void appendDetail(StringBuffer buffer, String fieldName, Object value) {
if (value instanceof Date) {
value = new SimpleDateFormat("yyyy-MM-dd").format(value);
}
buffer.append(value);
}
}
- Since:
- 1.0
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ToStringStyleThe default toString style.static final ToStringStyleThe JSON toString style.static final ToStringStyleThe multi line toString style.static final ToStringStyleThe no class name toString style.static final ToStringStyleThe no field names toString style.static final ToStringStyleThe short prefix toString style.static final ToStringStyleThe simple toString style. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidappend(StringBuffer buffer, String fieldName, boolean value) Appends to thetoStringabooleanvalue.voidappend(StringBuffer buffer, String fieldName, boolean[] array, Boolean fullDetail) Appends to thetoStringabooleanarray.voidappend(StringBuffer buffer, String fieldName, byte value) Appends to thetoStringabytevalue.voidappend(StringBuffer buffer, String fieldName, byte[] array, Boolean fullDetail) Appends to thetoStringabytearray.voidappend(StringBuffer buffer, String fieldName, char value) Appends to thetoStringacharvalue.voidappend(StringBuffer buffer, String fieldName, char[] array, Boolean fullDetail) Appends to thetoStringachararray.voidappend(StringBuffer buffer, String fieldName, double value) Appends to thetoStringadoublevalue.voidappend(StringBuffer buffer, String fieldName, double[] array, Boolean fullDetail) Appends to thetoStringadoublearray.voidappend(StringBuffer buffer, String fieldName, float value) Appends to thetoStringafloatvalue.voidappend(StringBuffer buffer, String fieldName, float[] array, Boolean fullDetail) Appends to thetoStringafloatarray.voidappend(StringBuffer buffer, String fieldName, int value) Appends to thetoStringanintvalue.voidappend(StringBuffer buffer, String fieldName, int[] array, Boolean fullDetail) Appends to thetoStringanintarray.voidappend(StringBuffer buffer, String fieldName, long value) Appends to thetoStringalongvalue.voidappend(StringBuffer buffer, String fieldName, long[] array, Boolean fullDetail) Appends to thetoStringalongarray.voidappend(StringBuffer buffer, String fieldName, short value) Appends to thetoStringashortvalue.voidappend(StringBuffer buffer, String fieldName, short[] array, Boolean fullDetail) Appends to thetoStringashortarray.voidappend(StringBuffer buffer, String fieldName, Object[] array, Boolean fullDetail) Appends to thetoStringanObjectarray.voidappend(StringBuffer buffer, String fieldName, Object value, Boolean fullDetail) protected voidappendClassName(StringBuffer buffer, Object object) Appends to thetoStringthe class name.protected voidappendContentEnd(StringBuffer buffer) Appends to thetoStringthe content end.protected voidappendContentStart(StringBuffer buffer) Appends to thetoStringthe content start.protected voidappendCyclicObject(StringBuffer buffer, String fieldName, Object value) Appends to thetoStringanObjectvalue that has been detected to participate in a cycle.protected voidappendDetail(StringBuffer buffer, String fieldName, boolean value) Appends to thetoStringabooleanvalue.protected voidappendDetail(StringBuffer buffer, String fieldName, boolean[] array) Appends to thetoStringthe detail of abooleanarray.protected voidappendDetail(StringBuffer buffer, String fieldName, byte value) Appends to thetoStringabytevalue.protected voidappendDetail(StringBuffer buffer, String fieldName, byte[] array) Appends to thetoStringthe detail of abytearray.protected voidappendDetail(StringBuffer buffer, String fieldName, char value) Appends to thetoStringacharvalue.protected voidappendDetail(StringBuffer buffer, String fieldName, char[] array) Appends to thetoStringthe detail of achararray.protected voidappendDetail(StringBuffer buffer, String fieldName, double value) Appends to thetoStringadoublevalue.protected voidappendDetail(StringBuffer buffer, String fieldName, double[] array) Appends to thetoStringthe detail of adoublearray.protected voidappendDetail(StringBuffer buffer, String fieldName, float value) Appends to thetoStringafloatvalue.protected voidappendDetail(StringBuffer buffer, String fieldName, float[] array) Appends to thetoStringthe detail of afloatarray.protected voidappendDetail(StringBuffer buffer, String fieldName, int value) Appends to thetoStringanintvalue.protected voidappendDetail(StringBuffer buffer, String fieldName, int[] array) Appends to thetoStringthe detail of anintarray.protected voidappendDetail(StringBuffer buffer, String fieldName, int i, Object item) Appends to thetoStringthe detail of anObjectarray item.protected voidappendDetail(StringBuffer buffer, String fieldName, long value) Appends to thetoStringalongvalue.protected voidappendDetail(StringBuffer buffer, String fieldName, long[] array) Appends to thetoStringthe detail of alongarray.protected voidappendDetail(StringBuffer buffer, String fieldName, short value) Appends to thetoStringashortvalue.protected voidappendDetail(StringBuffer buffer, String fieldName, short[] array) Appends to thetoStringthe detail of ashortarray.protected voidappendDetail(StringBuffer buffer, String fieldName, Object value) protected voidappendDetail(StringBuffer buffer, String fieldName, Object[] array) Appends to thetoStringthe detail of anObjectarray.protected voidappendDetail(StringBuffer buffer, String fieldName, Collection<?> coll) Appends to thetoStringaCollection.protected voidappendDetail(StringBuffer buffer, String fieldName, Map<?, ?> map) Appends to thetoStringaMap.voidappendEnd(StringBuffer buffer, Object object) Appends to thetoStringthe end of data indicator.protected voidappendFieldEnd(StringBuffer buffer, String fieldName) Appends to thetoStringthe field end.protected voidappendFieldSeparator(StringBuffer buffer) Appends to thetoStringthe field separator.protected voidappendFieldStart(StringBuffer buffer, String fieldName) Appends to thetoStringthe field start.protected voidappendIdentityHashCode(StringBuffer buffer, Object object) Appends theSystem.identityHashCode(java.lang.Object).protected voidappendInternal(StringBuffer buffer, String fieldName, Object value, boolean detail) Appends to thetoStringanObject, correctly interpreting its type.protected voidappendNullText(StringBuffer buffer, String fieldName) Appends to thetoStringan indicator fornull.voidappendStart(StringBuffer buffer, Object object) Appends to thetoStringthe start of data indicator.protected voidappendSummary(StringBuffer buffer, String fieldName, boolean[] array) Appends to thetoStringa summary of abooleanarray.protected voidappendSummary(StringBuffer buffer, String fieldName, byte[] array) Appends to thetoStringa summary of abytearray.protected voidappendSummary(StringBuffer buffer, String fieldName, char[] array) Appends to thetoStringa summary of achararray.protected voidappendSummary(StringBuffer buffer, String fieldName, double[] array) Appends to thetoStringa summary of adoublearray.protected voidappendSummary(StringBuffer buffer, String fieldName, float[] array) Appends to thetoStringa summary of afloatarray.protected voidappendSummary(StringBuffer buffer, String fieldName, int[] array) Appends to thetoStringa summary of anintarray.protected voidappendSummary(StringBuffer buffer, String fieldName, long[] array) Appends to thetoStringa summary of alongarray.protected voidappendSummary(StringBuffer buffer, String fieldName, short[] array) Appends to thetoStringa summary of ashortarray.protected voidappendSummary(StringBuffer buffer, String fieldName, Object value) protected voidappendSummary(StringBuffer buffer, String fieldName, Object[] array) Appends to thetoStringa summary of anObjectarray.protected voidappendSummarySize(StringBuffer buffer, String fieldName, int size) Appends to thetoStringa size summary.voidappendSuper(StringBuffer buffer, String superToString) Appends to thetoStringthe superclass toString.voidappendToString(StringBuffer buffer, String toString) Appends to thetoStringanother toString.protected StringGets the array end text.protected StringGets the array separator text.protected StringGets the array start text.protected StringGets the content end text.protected StringGets the content start text.protected StringGets the field name value separator text.protected StringGets the field separator text.protected StringGets the text to output whennullfound.Returns the registry of objects being traversed by thereflectionToStringmethods in the current thread.protected StringgetShortClassName(Class<?> cls) Gets the short class name for a class.protected StringGets the end text to output when aCollection,Mapor array size is output.protected StringGets the start text to output when aCollection,Mapor array size is output.protected StringGets the end text to output when anObjectis output in summary mode.protected StringGets the start text to output when anObjectis output in summary mode.protected booleanGets whether to output array content detail.protected booleanGets whether to use full detail when the caller doesn't specify.protected booleanGets whether the field separator should be added at the end of each buffer.protected booleanGets whether the field separator should be added at the start of each buffer.protected booleanisFullDetail(Boolean fullDetailRequest) Is this field to be output in full detail.protected booleanGets whether to use the class name.protected booleanGets whether to use the field names passed in.protected booleanGets whether to use the identity hash code.protected booleanGets whether to output short or long class names.protected voidreflectionAppendArrayDetail(StringBuffer buffer, String fieldName, Object array) Appends to thetoStringthe detail of an array type.protected voidremoveLastFieldSeparator(StringBuffer buffer) Remove the last field separator from the buffer.protected voidsetArrayContentDetail(boolean arrayContentDetail) Sets whether to output array content detail.protected voidsetArrayEnd(String arrayEnd) Sets the array end text.protected voidsetArraySeparator(String arraySeparator) Sets the array separator text.protected voidsetArrayStart(String arrayStart) Sets the array start text.protected voidsetContentEnd(String contentEnd) Sets the content end text.protected voidsetContentStart(String contentStart) Sets the content start text.protected voidsetDefaultFullDetail(boolean defaultFullDetail) Sets whether to use full detail when the caller doesn't specify.protected voidsetFieldNameValueSeparator(String fieldNameValueSeparator) Sets the field name value separator text.protected voidsetFieldSeparator(String fieldSeparator) Sets the field separator text.protected voidsetFieldSeparatorAtEnd(boolean fieldSeparatorAtEnd) Sets whether the field separator should be added at the end of each buffer.protected voidsetFieldSeparatorAtStart(boolean fieldSeparatorAtStart) Sets whether the field separator should be added at the start of each buffer.protected voidsetNullText(String nullText) Sets the text to output whennullfound.protected voidsetSizeEndText(String sizeEndText) Sets the end text to output when aCollection,Mapor array size is output.protected voidsetSizeStartText(String sizeStartText) Sets the start text to output when aCollection,Mapor array size is output.protected voidsetSummaryObjectEndText(String summaryObjectEndText) Sets the end text to output when anObjectis output in summary mode.protected voidsetSummaryObjectStartText(String summaryObjectStartText) Sets the start text to output when anObjectis output in summary mode.protected voidsetUseClassName(boolean useClassName) Sets whether to use the class name.protected voidsetUseFieldNames(boolean useFieldNames) Sets whether to use the field names passed in.protected voidsetUseIdentityHashCode(boolean useIdentityHashCode) Sets whether to use the identity hash code.protected voidsetUseShortClassName(boolean useShortClassName) Sets whether to output short or long class names.
-
Field Details
-
DEFAULT_STYLE
The default toString style. Using thePersonexample fromToStringBuilder, the output would look like this:Person@182f0db[name=John Doe,age=33,smoker=false]
-
MULTI_LINE_STYLE
The multi line toString style. Using thePersonexample fromToStringBuilder, the output would look like this:Person@182f0db[ name=John Doe age=33 smoker=false ]
-
NO_FIELD_NAMES_STYLE
The no field names toString style. Using thePersonexample fromToStringBuilder, the output would look like this:Person@182f0db[John Doe,33,false]
-
SHORT_PREFIX_STYLE
The short prefix toString style. Using thePersonexample fromToStringBuilder, the output would look like this:Person[name=John Doe,age=33,smoker=false]
- Since:
- 2.1
-
SIMPLE_STYLE
The simple toString style. Using thePersonexample fromToStringBuilder, the output would look like this:John Doe,33,false
-
NO_CLASS_NAME_STYLE
The no class name toString style. Using thePersonexample fromToStringBuilder, the output would look like this:[name=John Doe,age=33,smoker=false]
- Since:
- 3.4
-
JSON_STYLE
The JSON toString style. Using thePersonexample fromToStringBuilder, the output would look like this:{"name": "John Doe", "age": 33, "smoker": true}Note: Since field names are mandatory in JSON, this ToStringStyle will throw anUnsupportedOperationExceptionif no field name is passed in while appending. Furthermore This ToStringStyle will only generate valid JSON if referenced objects also produce JSON when callingtoString()on them.- Since:
- 3.4
- See Also:
-
-
Constructor Details
-
ToStringStyle
protected ToStringStyle()Constructor.
-
-
Method Details
-
getRegistry
Returns the registry of objects being traversed by thereflectionToStringmethods in the current thread.- Returns:
- Set the registry of objects being traversed
-
append
Appends to thetoStringabooleanvalue.- Parameters:
buffer- theStringBufferto populatefieldName- the field namevalue- the value to add to thetoString
-
append
Appends to thetoStringabooleanarray.- Parameters:
buffer- theStringBufferto populatefieldName- the field namearray- the array to add to the toStringfullDetail-truefor detail,falsefor summary info,nullfor style decides
-
append
Appends to thetoStringabytevalue.- Parameters:
buffer- theStringBufferto populatefieldName- the field namevalue- the value to add to thetoString
-
append
Appends to thetoStringabytearray.- Parameters:
buffer- theStringBufferto populatefieldName- the field namearray- the array to add to thetoStringfullDetail-truefor detail,falsefor summary info,nullfor style decides
-
append
Appends to thetoStringacharvalue.- Parameters:
buffer- theStringBufferto populatefieldName- the field namevalue- the value to add to thetoString
-
append
Appends to thetoStringachararray.- Parameters:
buffer- theStringBufferto populatefieldName- the field namearray- the array to add to thetoStringfullDetail-truefor detail,falsefor summary info,nullfor style decides
-
append
Appends to thetoStringadoublevalue.- Parameters:
buffer- theStringBufferto populatefieldName- the field namevalue- the value to add to thetoString
-
append
Appends to thetoStringadoublearray.- Parameters:
buffer- theStringBufferto populatefieldName- the field namearray- the array to add to the toStringfullDetail-truefor detail,falsefor summary info,nullfor style decides
-
append
Appends to thetoStringafloatvalue.- Parameters:
buffer- theStringBufferto populatefieldName- the field namevalue- the value to add to thetoString
-
append
Appends to thetoStringafloatarray.- Parameters:
buffer- theStringBufferto populatefieldName- the field namearray- the array to add to the toStringfullDetail-truefor detail,falsefor summary info,nullfor style decides
-
append
Appends to thetoStringanintvalue.- Parameters:
buffer- theStringBufferto populatefieldName- the field namevalue- the value to add to thetoString
-
append
Appends to thetoStringanintarray.- Parameters:
buffer- theStringBufferto populatefieldName- the field namearray- the array to add to thetoStringfullDetail-truefor detail,falsefor summary info,nullfor style decides
-
append
Appends to the
toStringalongvalue.- Parameters:
buffer- theStringBufferto populatefieldName- the field namevalue- the value to add to thetoString
-
append
Appends to thetoStringalongarray.- Parameters:
buffer- theStringBufferto populatefieldName- the field namearray- the array to add to thetoStringfullDetail-truefor detail,falsefor summary info,nullfor style decides
-
append
- Parameters:
buffer- theStringBufferto populatefieldName- the field namevalue- the value to add to thetoStringfullDetail-truefor detail,falsefor summary info,nullfor style decides
-
append
Appends to thetoStringanObjectarray.- Parameters:
buffer- theStringBufferto populatefieldName- the field namearray- the array to add to the toStringfullDetail-truefor detail,falsefor summary info,nullfor style decides
-
append
Appends to thetoStringashortvalue.- Parameters:
buffer- theStringBufferto populatefieldName- the field namevalue- the value to add to thetoString
-
append
Appends to thetoStringashortarray.- Parameters:
buffer- theStringBufferto populatefieldName- the field namearray- the array to add to thetoStringfullDetail-truefor detail,falsefor summary info,nullfor style decides
-
appendClassName
Appends to thetoStringthe class name.- Parameters:
buffer- theStringBufferto populateobject- theObjectwhose name to output
-
appendContentEnd
Appends to thetoStringthe content end.- Parameters:
buffer- theStringBufferto populate
-
appendContentStart
Appends to thetoStringthe content start.- Parameters:
buffer- theStringBufferto populate
-
appendCyclicObject
Appends to thetoStringanObjectvalue that has been detected to participate in a cycle. This implementation will print the standard string value of the value.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedvalue- the value to add to thetoString, notnull- Since:
- 2.2
-
appendDetail
Appends to thetoStringabooleanvalue.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedvalue- the value to add to thetoString
-
appendDetail
Appends to thetoStringthe detail of abooleanarray.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedarray- the array to add to thetoString, notnull
-
appendDetail
Appends to thetoStringabytevalue.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedvalue- the value to add to thetoString
-
appendDetail
Appends to thetoStringthe detail of abytearray.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedarray- the array to add to thetoString, notnull
-
appendDetail
Appends to thetoStringacharvalue.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedvalue- the value to add to thetoString
-
appendDetail
Appends to thetoStringthe detail of achararray.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedarray- the array to add to thetoString, notnull
-
appendDetail
Appends to thetoStringaCollection.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedcoll- theCollectionto add to thetoString, notnull
-
appendDetail
Appends to thetoStringadoublevalue.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedvalue- the value to add to thetoString
-
appendDetail
Appends to thetoStringthe detail of adoublearray.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedarray- the array to add to thetoString, notnull
-
appendDetail
Appends to thetoStringafloatvalue.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedvalue- the value to add to thetoString
-
appendDetail
Appends to thetoStringthe detail of afloatarray.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedarray- the array to add to thetoString, notnull
-
appendDetail
Appends to thetoStringanintvalue.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedvalue- the value to add to thetoString
-
appendDetail
Appends to thetoStringthe detail of anObjectarray item.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedi- the array item index to additem- the array item to add- Since:
- 3.11
-
appendDetail
Appends to thetoStringthe detail of anintarray.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedarray- the array to add to thetoString, notnull
-
appendDetail
Appends to thetoStringalongvalue.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedvalue- the value to add to thetoString
-
appendDetail
Appends to thetoStringthe detail of alongarray.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedarray- the array to add to thetoString, notnull
-
appendDetail
Appends to thetoStringaMap.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedmap- theMapto add to thetoString, notnull
-
appendDetail
- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedvalue- the value to add to thetoString, notnull
-
appendDetail
Appends to thetoStringthe detail of anObjectarray.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedarray- the array to add to thetoString, notnull
-
appendDetail
Appends to thetoStringashortvalue.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedvalue- the value to add to thetoString
-
appendDetail
Appends to thetoStringthe detail of ashortarray.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedarray- the array to add to thetoString, notnull
-
appendEnd
Appends to thetoStringthe end of data indicator.- Parameters:
buffer- theStringBufferto populateobject- theObjectto build atoStringfor.
-
appendFieldEnd
Appends to thetoStringthe field end.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appended
-
appendFieldSeparator
Appends to thetoStringthe field separator.- Parameters:
buffer- theStringBufferto populate
-
appendFieldStart
Appends to thetoStringthe field start.- Parameters:
buffer- theStringBufferto populatefieldName- the field name
-
appendIdentityHashCode
Appends theSystem.identityHashCode(java.lang.Object).- Parameters:
buffer- theStringBufferto populateobject- theObjectwhose id to output
-
appendInternal
Appends to thetoStringanObject, correctly interpreting its type.This method performs the main lookup by Class type to correctly route arrays,
Collections,Maps andObjectsto the appropriate method.Either detail or summary views can be specified.
If a cycle is detected, an object will be appended with the
Object.toString()format.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedvalue- the value to add to thetoString, notnulldetail- output detail or not
-
appendNullText
Appends to thetoStringan indicator fornull.The default indicator is
'<null>'.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appended
-
appendStart
Appends to thetoStringthe start of data indicator.- Parameters:
buffer- theStringBufferto populateobject- theObjectto build atoStringfor
-
appendSummary
Appends to thetoStringa summary of abooleanarray.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedarray- the array to add to thetoString, notnull
-
appendSummary
Appends to thetoStringa summary of abytearray.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedarray- the array to add to thetoString, notnull
-
appendSummary
Appends to thetoStringa summary of achararray.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedarray- the array to add to thetoString, notnull
-
appendSummary
Appends to thetoStringa summary of adoublearray.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedarray- the array to add to thetoString, notnull
-
appendSummary
Appends to thetoStringa summary of afloatarray.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedarray- the array to add to thetoString, notnull
-
appendSummary
Appends to thetoStringa summary of anintarray.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedarray- the array to add to thetoString, notnull
-
appendSummary
Appends to thetoStringa summary of alongarray.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedarray- the array to add to thetoString, notnull
-
appendSummary
- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedvalue- the value to add to thetoString, notnull
-
appendSummary
Appends to thetoStringa summary of anObjectarray.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedarray- the array to add to thetoString, notnull
-
appendSummary
Appends to thetoStringa summary of ashortarray.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedarray- the array to add to thetoString, notnull
-
appendSummarySize
Appends to thetoStringa size summary.The size summary is used to summarize the contents of
Collections,Maps and arrays.The output consists of a prefix, the passed in size and a suffix.
The default format is
'<size=n>'.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedsize- the size to append
-
appendSuper
Appends to thetoStringthe superclass toString.NOTE: It assumes that the toString has been created from the same ToStringStyle.
A
nullsuperToStringis ignored.- Parameters:
buffer- theStringBufferto populatesuperToString- thesuper.toString()- Since:
- 2.0
-
appendToString
Appends to thetoStringanother toString.NOTE: It assumes that the toString has been created from the same ToStringStyle.
A
nulltoStringis ignored.- Parameters:
buffer- theStringBufferto populatetoString- the additionaltoString- Since:
- 2.0
-
getArrayEnd
Gets the array end text.- Returns:
- the current array end text
-
getArraySeparator
Gets the array separator text.- Returns:
- the current array separator text
-
getArrayStart
Gets the array start text.- Returns:
- the current array start text
-
getContentEnd
Gets the content end text.- Returns:
- the current content end text
-
getContentStart
Gets the content start text.- Returns:
- the current content start text
-
getFieldNameValueSeparator
Gets the field name value separator text.- Returns:
- the current field name value separator text
-
getFieldSeparator
Gets the field separator text.- Returns:
- the current field separator text
-
getNullText
Gets the text to output whennullfound.- Returns:
- the current text to output when null found
-
getShortClassName
Gets the short class name for a class.The short class name is the class name excluding the package name.
- Parameters:
cls- theClassto get the short name of- Returns:
- the short name
-
getSizeEndText
Gets the end text to output when aCollection,Mapor array size is output.This is output after the size value.
- Returns:
- the current end of size text
-
getSizeStartText
Gets the start text to output when aCollection,Mapor array size is output.This is output before the size value.
- 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.
- 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.
- Returns:
- the current start of summary text
-
isArrayContentDetail
Gets whether to output array content detail.- Returns:
- the current array content detail setting
-
isDefaultFullDetail
Gets whether to use full detail when the caller doesn't specify.- Returns:
- the current defaultFullDetail flag
-
isFieldSeparatorAtEnd
Gets whether the field separator should be added at the end of each buffer.- Returns:
- fieldSeparatorAtEnd flag
- Since:
- 2.0
-
isFieldSeparatorAtStart
Gets whether the field separator should be added at the start of each buffer.- Returns:
- the fieldSeparatorAtStart flag
- Since:
- 2.0
-
isFullDetail
Is this field to be output in full detail.This method converts a detail request into a detail level. The calling code may request full detail (
true), but a subclass might ignore that and always returnfalse. The calling code may pass innullindicating that it doesn't care about the detail level. In this case the default detail level is used.- Parameters:
fullDetailRequest- the detail level requested- Returns:
- whether full detail is to be shown
-
isUseClassName
Gets whether to use the class name.- Returns:
- the current useClassName flag
-
isUseFieldNames
Gets whether to use the field names passed in.- Returns:
- the current useFieldNames flag
-
isUseIdentityHashCode
Gets whether to use the identity hash code.- Returns:
- the current useIdentityHashCode flag
-
isUseShortClassName
Gets whether to output short or long class names.- Returns:
- the current useShortClassName flag
- Since:
- 2.0
-
reflectionAppendArrayDetail
Appends to thetoStringthe detail of an array type.- Parameters:
buffer- theStringBufferto populatefieldName- the field name, typically not used as already appendedarray- the array to add to thetoString, notnull- Since:
- 2.0
-
removeLastFieldSeparator
Remove the last field separator from the buffer.- Parameters:
buffer- theStringBufferto populate- Since:
- 2.0
-
setArrayContentDetail
Sets whether to output array content detail.- Parameters:
arrayContentDetail- the new arrayContentDetail flag
-
setArrayEnd
Sets the array end text.nullis accepted, but will be converted to an empty String.- Parameters:
arrayEnd- the new array end text
-
setArraySeparator
Sets the array separator text.nullis accepted, but will be converted to an empty String.- Parameters:
arraySeparator- the new array separator text
-
setArrayStart
Sets the array start text.nullis accepted, but will be converted to an empty String.- Parameters:
arrayStart- the new array start text
-
setContentEnd
Sets the content end text.nullis accepted, but will be converted to an empty String.- Parameters:
contentEnd- the new content end text
-
setContentStart
Sets the content start text.nullis accepted, but will be converted to an empty String.- Parameters:
contentStart- the new content start text
-
setDefaultFullDetail
Sets whether to use full detail when the caller doesn't specify.- Parameters:
defaultFullDetail- the new defaultFullDetail flag
-
setFieldNameValueSeparator
Sets the field name value separator text.nullis accepted, but will be converted to an empty String.- 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.- Parameters:
fieldSeparator- the new field separator text
-
setFieldSeparatorAtEnd
Sets whether the field separator should be added at the end of each buffer.- Parameters:
fieldSeparatorAtEnd- the fieldSeparatorAtEnd flag- Since:
- 2.0
-
setFieldSeparatorAtStart
Sets whether the field separator should be added at the start of each buffer.- 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.- Parameters:
nullText- the new text to output when null found
-
setSizeEndText
Sets the end text to output when aCollection,Mapor array size is output.This is output after the size value.
nullis accepted, but will be converted to an empty String.- Parameters:
sizeEndText- the new end of size text
-
setSizeStartText
Sets the start text to output when aCollection,Mapor array size is output.This is output before the size value.
nullis accepted, but will be converted to an empty String.- 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.- 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.- Parameters:
summaryObjectStartText- the new start of summary text
-
setUseClassName
Sets whether to use the class name.- Parameters:
useClassName- the new useClassName flag
-
setUseFieldNames
Sets whether to use the field names passed in.- Parameters:
useFieldNames- the new useFieldNames flag
-
setUseIdentityHashCode
Sets whether to use the identity hash code.- Parameters:
useIdentityHashCode- the new useIdentityHashCode flag
-
setUseShortClassName
Sets whether to output short or long class names.- Parameters:
useShortClassName- the new useShortClassName flag- Since:
- 2.0
-