org.starchartlabs.alloy.core

Class MoreObjects.ToStringHelper

java.lang.Object

org.starchartlabs.alloy.core.MoreObjects.ToStringHelper

Enclosing class:

MoreObjects

public static final class MoreObjects.ToStringHelper
extends java.lang.Object

Support class for MoreObjects.toStringHelper(java.lang.Object). Builder which allows reducing boilerplate around toString implementations

Since:

0.1.0

Method Summary

Modifier and Type	Method and Description
MoreObjects.ToStringHelper	add(java.lang.String name, java.lang.Object value) Adds a name/value pair to the formatted output in name=value format.
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 a null value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

omitNullValues

public MoreObjects.ToStringHelper omitNullValues()

Configures the MoreObjects.ToStringHelper so toString() will ignore properties with a null value. The order of calling this method, relative to the add()/addValue() methods, is not significant

Returns:

This builder instance, for further configuration

Since:

0.1.0

add

public MoreObjects.ToStringHelper add(java.lang.String name,
                                      @Nullable
                                      java.lang.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

Parameters:

name - Label for the value being added, must not be null

value - The data to represent in the built string

Returns:

This builder instance, for further configuration

Since:

0.1.0

addValue

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

Parameters:

value - The data to represent in the built string

Returns:

This builder instance, for further configuration

Since:

0.1.0

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object