Package org.openstack4j.util

Class ToStringHelper

java.lang.Object

org.openstack4j.util.ToStringHelper

public final class ToStringHelper
extends Object

Extracted from com.google.common.base.MoreObjects#toStringHelper.

Since:

18.0 (since 2.0 as Objects.ToStringHelper).

Author:

Jason Lee

Constructor Summary

Constructors

Constructor	Description
ToStringHelper(Object subject)
ToStringHelper(String className)

Method Summary

Modifier and Type	Method	Description
ToStringHelper	add(String name, boolean value)	Adds a name/value pair to the formatted output in name=value format.
ToStringHelper	add(String name, char value)	Adds a name/value pair to the formatted output in name=value format.
ToStringHelper	add(String name, double value)	Adds a name/value pair to the formatted output in name=value format.
ToStringHelper	add(String name, float value)	Adds a name/value pair to the formatted output in name=value format.
ToStringHelper	add(String name, int value)	Adds a name/value pair to the formatted output in name=value format.
ToStringHelper	add(String name, long value)	Adds a name/value pair to the formatted output in name=value format.
ToStringHelper	add(String name, Object value)	Adds a name/value pair to the formatted output in name=value format.
ToStringHelper	addValue(Object value)	Adds an unnamed value to the formatted output.
String	toString()	Returns a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToStringHelper

public ToStringHelper(Object subject)

ToStringHelper

public ToStringHelper(String className)

Method Detail

add

public ToStringHelper add(String name,
                          @Nullable
                          Object value)

Adds a name/value pair to the formatted output in name=value format. If value is null this name/value pair will not be added.

add

public ToStringHelper add(String name,
                          boolean value)

Adds a name/value pair to the formatted output in name=value format.

Since:

18.0 (since 11.0 as Objects.ToStringHelper.add()).

add

public ToStringHelper add(String name,
                          char value)

Adds a name/value pair to the formatted output in name=value format.

Since:

18.0 (since 11.0 as Objects.ToStringHelper.add()).

add

public ToStringHelper add(String name,
                          double value)

Adds a name/value pair to the formatted output in name=value format.

Since:

18.0 (since 11.0 as Objects.ToStringHelper.add()).

add

public ToStringHelper add(String name,
                          float value)

Adds a name/value pair to the formatted output in name=value format.

Since:

18.0 (since 11.0 as Objects.ToStringHelper.add()).

add

public ToStringHelper add(String name,
                          int value)

Adds a name/value pair to the formatted output in name=value format.

Since:

18.0 (since 11.0 as Objects.ToStringHelper.add()).

add

public ToStringHelper add(String name,
                          long value)

Adds a name/value pair to the formatted output in name=value format.

Since:

18.0 (since 11.0 as Objects.ToStringHelper.add()).

addValue

public ToStringHelper addValue(@Nullable
                               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.

toString

public String toString()

Returns a string.

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:

toString in class Object