Class MoreObjects.ToStringHelper
-
- com.google.common.base.MoreObjects.ToStringHelper
-
- Enclosing class:
- MoreObjects
public static final class MoreObjects.ToStringHelper extends
Support class forMoreObjects.toStringHelper(java.lang.Object)
.- Since:
- 18.0 (since 2.0 as
Objects.ToStringHelper
). - Author:
- Jason Lee
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MoreObjects.ToStringHelper
name, boolean value)
Adds a name/value pair to the formatted output inname=value
format.MoreObjects.ToStringHelper
name, char value)
Adds a name/value pair to the formatted output inname=value
format.MoreObjects.ToStringHelper
name, double value)
Adds a name/value pair to the formatted output inname=value
format.MoreObjects.ToStringHelper
name, float value)
Adds a name/value pair to the formatted output inname=value
format.MoreObjects.ToStringHelper
name, int value)
Adds a name/value pair to the formatted output inname=value
format.MoreObjects.ToStringHelper
name, long value)
Adds a name/value pair to the formatted output inname=value
format.MoreObjects.ToStringHelper
name, value)
Adds a name/value pair to the formatted output inname=value
format.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
value)
Adds an unnamed value to the formatted output.MoreObjects.ToStringHelper
omitNullValues()
Configures theMoreObjects.ToStringHelper
sotoString()
will ignore properties with null value.toString()
Returns a string in the format specified byMoreObjects.toStringHelper(Object)
.
-
-
-
Method Detail
-
omitNullValues
public MoreObjects.ToStringHelper omitNullValues()
Configures theMoreObjects.ToStringHelper
sotoString()
will ignore properties with null value. The order of calling this method, relative to theadd()
/addValue()
methods, is not significant.- Since:
- 18.0 (since 12.0 as
Objects.ToStringHelper.omitNullValues()
).
-
add
public name, value)
Adds a name/value pair to the formatted output inname=value
format. Ifvalue
isnull
, the string"null"
is used, unlessomitNullValues()
is called, in which case this name/value pair will not be added.
-
add
public name, boolean value)
Adds a name/value pair to the formatted output inname=value
format.- Since:
- 18.0 (since 11.0 as
Objects.ToStringHelper.add()
).
-
add
public name, char value)
Adds a name/value pair to the formatted output inname=value
format.- Since:
- 18.0 (since 11.0 as
Objects.ToStringHelper.add()
).
-
add
public name, double value)
Adds a name/value pair to the formatted output inname=value
format.- Since:
- 18.0 (since 11.0 as
Objects.ToStringHelper.add()
).
-
add
public name, float value)
Adds a name/value pair to the formatted output inname=value
format.- Since:
- 18.0 (since 11.0 as
Objects.ToStringHelper.add()
).
-
add
public name, int value)
Adds a name/value pair to the formatted output inname=value
format.- Since:
- 18.0 (since 11.0 as
Objects.ToStringHelper.add()
).
-
add
public name, long value)
Adds a name/value pair to the formatted output inname=value
format.- Since:
- 18.0 (since 11.0 as
Objects.ToStringHelper.add()
).
-
addValue
public 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.
-
addValue
public MoreObjects.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.- Since:
- 18.0 (since 11.0 as
Objects.ToStringHelper.addValue()
).
-
addValue
public MoreObjects.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.- Since:
- 18.0 (since 11.0 as
Objects.ToStringHelper.addValue()
).
-
addValue
public MoreObjects.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.- Since:
- 18.0 (since 11.0 as
Objects.ToStringHelper.addValue()
).
-
addValue
public MoreObjects.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.- Since:
- 18.0 (since 11.0 as
Objects.ToStringHelper.addValue()
).
-
addValue
public MoreObjects.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.- Since:
- 18.0 (since 11.0 as
Objects.ToStringHelper.addValue()
).
-
addValue
public MoreObjects.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.- Since:
- 18.0 (since 11.0 as
Objects.ToStringHelper.addValue()
).
-
toString
public toString()
Returns a string in the format specified byMoreObjects.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).
- Overrides:
in class
- Returns:
- a string representation of the object.
-
-