public static final class MoreObjects.ToStringHelper
extends java.lang.Object
MoreObjects.toStringHelper(java.lang.Object)
.Objects.ToStringHelper
).Modifier and Type | Class and Description |
---|---|
private static class |
MoreObjects.ToStringHelper.ValueHolder |
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
className |
private MoreObjects.ToStringHelper.ValueHolder |
holderHead |
private MoreObjects.ToStringHelper.ValueHolder |
holderTail |
private boolean |
omitNullValues |
Modifier | Constructor and Description |
---|---|
private |
ToStringHelper(java.lang.String className)
Use
MoreObjects.toStringHelper(Object) to create an instance. |
Modifier and Type | Method and Description |
---|---|
MoreObjects.ToStringHelper |
add(java.lang.String name,
boolean value)
Adds a name/value pair to the formatted output in
name=value format. |
MoreObjects.ToStringHelper |
add(java.lang.String name,
char value)
Adds a name/value pair to the formatted output in
name=value format. |
MoreObjects.ToStringHelper |
add(java.lang.String name,
double value)
Adds a name/value pair to the formatted output in
name=value format. |
MoreObjects.ToStringHelper |
add(java.lang.String name,
float value)
Adds a name/value pair to the formatted output in
name=value format. |
MoreObjects.ToStringHelper |
add(java.lang.String name,
int value)
Adds a name/value pair to the formatted output in
name=value format. |
MoreObjects.ToStringHelper |
add(java.lang.String name,
long value)
Adds a name/value pair to the formatted output in
name=value format. |
MoreObjects.ToStringHelper |
add(java.lang.String name,
java.lang.Object value)
Adds a name/value pair to the formatted output in
name=value format. |
private MoreObjects.ToStringHelper.ValueHolder |
addHolder() |
private MoreObjects.ToStringHelper |
addHolder(java.lang.Object value) |
private MoreObjects.ToStringHelper |
addHolder(java.lang.String name,
java.lang.Object value) |
MoreObjects.ToStringHelper |
addValue(boolean value)
Adds an unnamed value to the formatted output.
|
MoreObjects.ToStringHelper |
addValue(char value)
Adds an unnamed value to the formatted output.
|
MoreObjects.ToStringHelper |
addValue(double value)
Adds an unnamed value to the formatted output.
|
MoreObjects.ToStringHelper |
addValue(float value)
Adds an unnamed value to the formatted output.
|
MoreObjects.ToStringHelper |
addValue(int value)
Adds an unnamed value to the formatted output.
|
MoreObjects.ToStringHelper |
addValue(long value)
Adds an unnamed value to the formatted output.
|
MoreObjects.ToStringHelper |
addValue(java.lang.Object value)
Adds an unnamed value to the formatted output.
|
MoreObjects.ToStringHelper |
omitNullValues()
Configures the
MoreObjects.ToStringHelper so toString() will ignore properties with null
value. |
java.lang.String |
toString()
Returns a string in the format specified by
MoreObjects.toStringHelper(Object) . |
private final java.lang.String className
private final MoreObjects.ToStringHelper.ValueHolder holderHead
private MoreObjects.ToStringHelper.ValueHolder holderTail
private boolean omitNullValues
private ToStringHelper(java.lang.String className)
MoreObjects.toStringHelper(Object)
to create an instance.public MoreObjects.ToStringHelper omitNullValues()
MoreObjects.ToStringHelper
so toString()
will ignore properties with null
value. The order of calling this method, relative to the add()
/addValue()
methods, is not significant.Objects.ToStringHelper.omitNullValues()
).public MoreObjects.ToStringHelper add(java.lang.String name, @Nullable java.lang.Object value)
name=value
format. If value
is null
, the string "null"
is used, unless omitNullValues()
is
called, in which case this name/value pair will not be added.public MoreObjects.ToStringHelper add(java.lang.String name, boolean value)
name=value
format.Objects.ToStringHelper.add()
).public MoreObjects.ToStringHelper add(java.lang.String name, char value)
name=value
format.Objects.ToStringHelper.add()
).public MoreObjects.ToStringHelper add(java.lang.String name, double value)
name=value
format.Objects.ToStringHelper.add()
).public MoreObjects.ToStringHelper add(java.lang.String name, float value)
name=value
format.Objects.ToStringHelper.add()
).public MoreObjects.ToStringHelper add(java.lang.String name, int value)
name=value
format.Objects.ToStringHelper.add()
).public MoreObjects.ToStringHelper add(java.lang.String name, long value)
name=value
format.Objects.ToStringHelper.add()
).public MoreObjects.ToStringHelper addValue(@Nullable java.lang.Object value)
It is strongly encouraged to use add(String, Object)
instead and give value a
readable name.
public MoreObjects.ToStringHelper addValue(boolean value)
It is strongly encouraged to use add(String, boolean)
instead and give value a
readable name.
Objects.ToStringHelper.addValue()
).public MoreObjects.ToStringHelper addValue(char value)
It is strongly encouraged to use add(String, char)
instead and give value a
readable name.
Objects.ToStringHelper.addValue()
).public MoreObjects.ToStringHelper addValue(double value)
It is strongly encouraged to use add(String, double)
instead and give value a
readable name.
Objects.ToStringHelper.addValue()
).public MoreObjects.ToStringHelper addValue(float value)
It is strongly encouraged to use add(String, float)
instead and give value a
readable name.
Objects.ToStringHelper.addValue()
).public MoreObjects.ToStringHelper addValue(int value)
It is strongly encouraged to use add(String, int)
instead and give value a
readable name.
Objects.ToStringHelper.addValue()
).public MoreObjects.ToStringHelper addValue(long value)
It is strongly encouraged to use add(String, long)
instead and give value a
readable name.
Objects.ToStringHelper.addValue()
).public java.lang.String toString()
MoreObjects.toStringHelper(Object)
.
After calling this method, you can keep adding more properties to later call toString() again and get a more complete representation of the same object; but properties cannot be removed, so this only allows limited reuse of the helper instance. The helper allows duplication of properties (multiple name/value pairs with the same name can be added).
toString
in class java.lang.Object
private MoreObjects.ToStringHelper.ValueHolder addHolder()
private MoreObjects.ToStringHelper addHolder(@Nullable java.lang.Object value)
private MoreObjects.ToStringHelper addHolder(java.lang.String name, @Nullable java.lang.Object value)