Objects.ToStringHelper
extends Object| java.lang.Object | |
| ↳ | com.facebook.common.internal.Objects.ToStringHelper |
Class Overview
Support class for toStringHelper(Class).
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Objects.ToStringHelper |
add(String name, boolean value)
Adds a name/value pair to the formatted output in
name=value format. | ||||||||||
| Objects.ToStringHelper |
add(String name, Object value)
Adds a name/value pair to the formatted output in
name=value format. | ||||||||||
| Objects.ToStringHelper |
add(String name, char value)
Adds a name/value pair to the formatted output in
name=value format. | ||||||||||
| Objects.ToStringHelper |
add(String name, float value)
Adds a name/value pair to the formatted output in
name=value format. | ||||||||||
| Objects.ToStringHelper |
add(String name, int value)
Adds a name/value pair to the formatted output in
name=value format. | ||||||||||
| Objects.ToStringHelper |
add(String name, long value)
Adds a name/value pair to the formatted output in
name=value format. | ||||||||||
| Objects.ToStringHelper |
add(String name, double value)
Adds a name/value pair to the formatted output in
name=value format. | ||||||||||
| Objects.ToStringHelper |
addValue(int value)
Adds an unnamed value to the formatted output.
| ||||||||||
| Objects.ToStringHelper |
addValue(double value)
Adds an unnamed value to the formatted output.
| ||||||||||
| Objects.ToStringHelper |
addValue(boolean value)
Adds an unnamed value to the formatted output.
| ||||||||||
| Objects.ToStringHelper |
addValue(Object value)
Adds an unnamed value to the formatted output.
| ||||||||||
| Objects.ToStringHelper |
addValue(float value)
Adds an unnamed value to the formatted output.
| ||||||||||
| Objects.ToStringHelper |
addValue(char value)
Adds an unnamed value to the formatted output.
| ||||||||||
| Objects.ToStringHelper |
addValue(long value)
Adds an unnamed value to the formatted output.
| ||||||||||
| Objects.ToStringHelper |
omitNullValues()
Configures the
Objects.ToStringHelper so toString() will ignore properties with null
value. | ||||||||||
| String |
toString()
Returns a string in the format specified by
toStringHelper(Object). | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Methods
public Objects.ToStringHelper add (String name, boolean value)
Adds a name/value pair to the formatted output in name=value format.
public Objects.ToStringHelper add (String name, Object value)
Adds a name/value pair to the formatted output in 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 Objects.ToStringHelper add (String name, char value)
Adds a name/value pair to the formatted output in name=value format.
public Objects.ToStringHelper add (String name, float value)
Adds a name/value pair to the formatted output in name=value format.
public Objects.ToStringHelper add (String name, int value)
Adds a name/value pair to the formatted output in name=value format.
public Objects.ToStringHelper add (String name, long value)
Adds a name/value pair to the formatted output in name=value format.
public Objects.ToStringHelper add (String name, double value)
Adds a name/value pair to the formatted output in name=value format.
public Objects.ToStringHelper addValue (int value)
Adds an unnamed value to the formatted output.
It is strongly encouraged to use add(String, int) instead and give value a
readable name.
public Objects.ToStringHelper addValue (double value)
Adds an unnamed value to the formatted output.
It is strongly encouraged to use add(String, double) instead and give value a
readable name.
public Objects.ToStringHelper addValue (boolean value)
Adds an unnamed value to the formatted output.
It is strongly encouraged to use add(String, boolean) instead and give value a
readable name.
public Objects.ToStringHelper addValue (Object value)
Adds an unnamed value to the formatted output.
It is strongly encouraged to use add(String, Object) instead and give value a
readable name.
public Objects.ToStringHelper addValue (float value)
Adds an unnamed value to the formatted output.
It is strongly encouraged to use add(String, float) instead and give value a
readable name.
public Objects.ToStringHelper addValue (char value)
Adds an unnamed value to the formatted output.
It is strongly encouraged to use add(String, char) instead and give value a
readable name.
public Objects.ToStringHelper addValue (long value)
Adds an unnamed value to the formatted output.
It is strongly encouraged to use add(String, long) instead and give value a
readable name.
public Objects.ToStringHelper omitNullValues ()
Configures the Objects.ToStringHelper so toString() will ignore properties with null
value. The order of calling this method, relative to the add()/addValue()
methods, is not significant.
public String toString ()
Returns a string in the format specified by 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).