Package org.apache.commons.lang3.builder

Class ToStringStyle.JsonToStringStyle

java.lang.Object

org.apache.commons.lang3.builder.ToStringStyle

org.apache.commons.lang3.builder.ToStringStyle.JsonToStringStyle

All Implemented Interfaces:

Serializable

Enclosing class:

ToStringStyle

private static final class ToStringStyle.JsonToStringStyle
extends ToStringStyle

ToStringStyle that outputs with JSON format.

This is an inner class rather than using StandardToStringStyle to ensure its immutability.

Since:

3.4

See Also:

• json.org

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	FIELD_NAME_QUOTE
private static final long	serialVersionUID

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

Constructor	Description
JsonToStringStyle()	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
void	append(StringBuffer buffer, String fieldName, boolean[] array, Boolean fullDetail)	Appends to the toString a boolean array.
void	append(StringBuffer buffer, String fieldName, byte[] array, Boolean fullDetail)	Appends to the toString a byte array.
void	append(StringBuffer buffer, String fieldName, char[] array, Boolean fullDetail)	Appends to the toString a char array.
void	append(StringBuffer buffer, String fieldName, double[] array, Boolean fullDetail)	Appends to the toString a double array.
void	append(StringBuffer buffer, String fieldName, float[] array, Boolean fullDetail)	Appends to the toString a float array.
void	append(StringBuffer buffer, String fieldName, int[] array, Boolean fullDetail)	Appends to the toString an int array.
void	append(StringBuffer buffer, String fieldName, long[] array, Boolean fullDetail)	Appends to the toString a long array.
void	append(StringBuffer buffer, String fieldName, short[] array, Boolean fullDetail)	Appends to the toString a short array.
void	append(StringBuffer buffer, String fieldName, Object[] array, Boolean fullDetail)	Appends to the toString an Object array.
void	append(StringBuffer buffer, String fieldName, Object value, Boolean fullDetail)	Appends to the toString an Object value, printing the full toString of the Object passed in.
protected void	appendDetail(StringBuffer buffer, String fieldName, char value)	Appends to the toString a char value.
protected void	appendDetail(StringBuffer buffer, String fieldName, Object value)	Appends to the toString an Object value, printing the full detail of the Object.
protected void	appendDetail(StringBuffer buffer, String fieldName, Collection<?> coll)	Appends to the toString a Collection.
protected void	appendDetail(StringBuffer buffer, String fieldName, Map<?,?> map)	Appends to the toString a Map.
protected void	appendFieldStart(StringBuffer buffer, String fieldName)	Appends to the toString the field start.
private void	appendValueAsString(StringBuffer buffer, String value)	Appends the given String enclosed in double-quotes to the given StringBuffer.
private void	checkAppendInput(String fieldName, Boolean fullDetail)
private void	checkFieldName(String fieldName)
private void	checkIsFullDetail(Boolean fullDetail)
private boolean	isJsonArray(String valueAsString)
private boolean	isJsonObject(String valueAsString)
private Object	readResolve()	Ensure Singleton after serialization.

Methods inherited from class org.apache.commons.lang3.builder.ToStringStyle

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, appendEnd, appendFieldEnd, appendFieldSeparator, 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, getRegistry, getShortClassName, getSizeEndText, getSizeStartText, getSummaryObjectEndText, getSummaryObjectStartText, isArrayContentDetail, isDefaultFullDetail, isFieldSeparatorAtEnd, isFieldSeparatorAtStart, isFullDetail, isRegistered, isUseClassName, isUseFieldNames, isUseIdentityHashCode, isUseShortClassName, reflectionAppendArrayDetail, register, removeLastFieldSeparator, setArrayContentDetail, setArrayEnd, setArraySeparator, setArrayStart, setContentEnd, setContentStart, setDefaultFullDetail, setFieldNameValueSeparator, setFieldSeparator, setFieldSeparatorAtEnd, setFieldSeparatorAtStart, setNullText, setSizeEndText, setSizeStartText, setSummaryObjectEndText, setSummaryObjectStartText, setUseClassName, setUseFieldNames, setUseIdentityHashCode, setUseShortClassName, unregister

Methods inherited from class java.lang.Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

FIELD_NAME_QUOTE

private static final String FIELD_NAME_QUOTE

See Also:

• Constant Field Values

Constructor Details

JsonToStringStyle

JsonToStringStyle()

Constructs a new instance.

Use the static constant rather than instantiating.

Method Details

append

public void append(StringBuffer buffer,
 String fieldName,
 boolean[] array,
 Boolean fullDetail)

Description copied from class: ToStringStyle

Appends to the toString a boolean array.

Overrides:

append in class ToStringStyle

Parameters:

buffer - the StringBuffer to populate.

fieldName - the field name.

array - the array to add to the toString.

fullDetail - true for detail, false for summary info, null for style decides.

append

public void append(StringBuffer buffer,
 String fieldName,
 byte[] array,
 Boolean fullDetail)

Description copied from class: ToStringStyle

Appends to the toString a byte array.

Overrides:

append in class ToStringStyle

Parameters:

buffer - the StringBuffer to populate.

fieldName - the field name.

array - the array to add to the toString.

fullDetail - true for detail, false for summary info, null for style decides.

append

public void append(StringBuffer buffer,
 String fieldName,
 char[] array,
 Boolean fullDetail)

Description copied from class: ToStringStyle

Appends to the toString a char array.

Overrides:

append in class ToStringStyle

Parameters:

buffer - the StringBuffer to populate.

fieldName - the field name.

array - the array to add to the toString.

fullDetail - true for detail, false for summary info, null for style decides.

append

public void append(StringBuffer buffer,
 String fieldName,
 double[] array,
 Boolean fullDetail)

Description copied from class: ToStringStyle

Appends to the toString a double array.

Overrides:

append in class ToStringStyle

Parameters:

buffer - the StringBuffer to populate.

fieldName - the field name.

array - the array to add to the toString.

fullDetail - true for detail, false for summary info, null for style decides.

append

public void append(StringBuffer buffer,
 String fieldName,
 float[] array,
 Boolean fullDetail)

Description copied from class: ToStringStyle

Appends to the toString a float array.

Overrides:

append in class ToStringStyle

Parameters:

buffer - the StringBuffer to populate.

fieldName - the field name.

array - the array to add to the toString.

fullDetail - true for detail, false for summary info, null for style decides.

append

public void append(StringBuffer buffer,
 String fieldName,
 int[] array,
 Boolean fullDetail)

Description copied from class: ToStringStyle

Appends to the toString an int array.

Overrides:

append in class ToStringStyle

Parameters:

buffer - the StringBuffer to populate.

fieldName - the field name.

array - the array to add to the toString.

fullDetail - true for detail, false for summary info, null for style decides.

append

public void append(StringBuffer buffer,
 String fieldName,
 long[] array,
 Boolean fullDetail)

Description copied from class: ToStringStyle

Appends to the toString a long array.

Overrides:

append in class ToStringStyle

Parameters:

buffer - the StringBuffer to populate.

fieldName - the field name.

array - the array to add to the toString.

fullDetail - true for detail, false for summary info, null for style decides.

append

public void append(StringBuffer buffer,
 String fieldName,
 Object value,
 Boolean fullDetail)

Description copied from class: ToStringStyle

Appends to the toString an Object value, printing the full toString of the Object passed in.

Overrides:

append in class ToStringStyle

Parameters:

buffer - the StringBuffer to populate.

fieldName - the field name.

value - the value to add to the toString.

fullDetail - true for detail, false for summary info, null for style decides.

append

public void append(StringBuffer buffer,
 String fieldName,
 Object[] array,
 Boolean fullDetail)

Description copied from class: ToStringStyle

Appends to the toString an Object array.

Overrides:

append in class ToStringStyle

Parameters:

buffer - the StringBuffer to populate.

fieldName - the field name.

array - the array to add to the toString.

fullDetail - true for detail, false for summary info, null for style decides.

append

public void append(StringBuffer buffer,
 String fieldName,
 short[] array,
 Boolean fullDetail)

Description copied from class: ToStringStyle

Appends to the toString a short array.

Overrides:

append in class ToStringStyle

Parameters:

buffer - the StringBuffer to populate.

fieldName - the field name.

array - the array to add to the toString.

fullDetail - true for detail, false for summary info, null for style decides.

appendDetail

protected void appendDetail(StringBuffer buffer,
 String fieldName,
 char value)

Description copied from class: ToStringStyle

Appends to the toString a char value.

Overrides:

appendDetail in class ToStringStyle

Parameters:

buffer - the StringBuffer to populate.

fieldName - the field name, typically not used as already appended.

value - the value to add to the toString.

appendDetail

protected void appendDetail(StringBuffer buffer,
 String fieldName,
 Collection<?> coll)

Description copied from class: ToStringStyle

Appends to the toString a Collection.

Overrides:

appendDetail in class ToStringStyle

Parameters:

buffer - the StringBuffer to populate.

fieldName - the field name, typically not used as already appended.

coll - the Collection to add to the toString, not null.

appendDetail

protected void appendDetail(StringBuffer buffer,
 String fieldName,
 Map<?,?> map)

Description copied from class: ToStringStyle

Appends to the toString a Map.

Overrides:

appendDetail in class ToStringStyle

Parameters:

buffer - the StringBuffer to populate.

fieldName - the field name, typically not used as already appended.

map - the Map to add to the toString, not null.

appendDetail

protected void appendDetail(StringBuffer buffer,
 String fieldName,
 Object value)

Description copied from class: ToStringStyle

Appends to the toString an Object value, printing the full detail of the Object.

Overrides:

appendDetail in class ToStringStyle

Parameters:

buffer - the StringBuffer to populate.

fieldName - the field name, typically not used as already appended.

value - the value to add to the toString, not null.

appendFieldStart

protected void appendFieldStart(StringBuffer buffer,
 String fieldName)

Description copied from class: ToStringStyle

Appends to the toString the field start.

Overrides:

appendFieldStart in class ToStringStyle

Parameters:

buffer - the StringBuffer to populate.

fieldName - the field name.

appendValueAsString

private void appendValueAsString(StringBuffer buffer,
 String value)

Appends the given String enclosed in double-quotes to the given StringBuffer.

Parameters:

buffer - the StringBuffer to append the value to.

value - the value to append.

checkAppendInput

private void checkAppendInput(String fieldName,
 Boolean fullDetail)

checkFieldName

private void checkFieldName(String fieldName)

checkIsFullDetail

private void checkIsFullDetail(Boolean fullDetail)

isJsonArray

private boolean isJsonArray(String valueAsString)

isJsonObject

private boolean isJsonObject(String valueAsString)

readResolve

private Object readResolve()

Ensure Singleton after serialization.

Returns:

the singleton