Objects.ToStringHelper (Commons Guava

java.lang.Object
- de.weltraumschaf.commons.guava.Objects.ToStringHelper

Enclosing class:

Objects
```
public static final class Objects.ToStringHelper
extends Object
```
Support class for Objects.toStringHelper(java.lang.Object).

Since:

2.0.0

Author:

Jason Lee

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class Objects.ToStringHelper.ValueHolder
Value class to hold properties.

Nested Classes
Modifier and Type	Class and Description
`private static class`	`Objects.ToStringHelper.ValueHolder` Value class to hold properties.

Field Summary

Fields
Modifier and Type	Field and Description
`private String`	`className` Name of rendered class.
`private static int`	`DEFAULT_BUFFER_SIZE` Default size for to string buffer.
`private Objects.ToStringHelper.ValueHolder`	`holderHead` Holds the first member.
`private Objects.ToStringHelper.ValueHolder`	`holderTail` Holds the last member.
`private boolean`	`omitNullValues` Whether `null` values should be omitted or not.

Constructor Summary

Constructors
Modifier Constructor and Description

private ToStringHelper(String className)
Use Objects.toStringHelper(Object) to create an instance.

Constructors
Modifier	Constructor and Description
`private`	`ToStringHelper(String className)` Use `Objects.toStringHelper(Object)` to create an instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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, char 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`	`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, Object value)` Adds a name/value pair to the formatted output in `name=value` format.
`private Objects.ToStringHelper.ValueHolder`	`addHolder()` Links a new `Objects.ToStringHelper.ValueHolder` to the tail of the values linked list and returns it.
`private Objects.ToStringHelper`	`addHolder(Object value)` Adds an unnamed value to the formatted output.
`private Objects.ToStringHelper`	`addHolder(String name, Object value)` Adds an named value to the formatted output.
`Objects.ToStringHelper`	`addValue(boolean 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(double 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(int value)` Adds an unnamed value to the formatted output.
`Objects.ToStringHelper`	`addValue(long value)` Adds an unnamed value to the formatted output.
`Objects.ToStringHelper`	`addValue(Object 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 `Objects.toStringHelper(Object)`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_BUFFER_SIZE
```
private static final int DEFAULT_BUFFER_SIZE
```
    Default size for to string buffer.
    
    See Also:
    
    Constant Field Values
  - className
```
private final String className
```
    Name of rendered class.
  - holderHead
```
private final Objects.ToStringHelper.ValueHolder holderHead
```
    Holds the first member.
  - holderTail
```
private Objects.ToStringHelper.ValueHolder holderTail
```
    Holds the last member.
  - omitNullValues
```
private boolean omitNullValues
```
    Whether null values should be omitted or not.
- Constructor Detail
  - ToStringHelper
```
private ToStringHelper(String className)
```
    Use Objects.toStringHelper(Object) to create an instance.
    
    Parameters:
    
    className - must not be null
- Method Detail
  - omitNullValues
```
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.
    
    Returns:
    
    self for method chaining
  - add
```
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.
    
    Parameters:
    
    name - name of property
    
    value - value of property
    
    Returns:
    
    self for method chaining
  - add
```
public Objects.ToStringHelper add(String name,
                                  boolean value)
```
    Adds a name/value pair to the formatted output in name=value format.
    
    Parameters:
    
    name - name of property
    
    value - value of property
    
    Returns:
    
    self for method chaining
  - add
```
public Objects.ToStringHelper add(String name,
                                  char value)
```
    Adds a name/value pair to the formatted output in name=value format.
    
    Parameters:
    
    name - name of property
    
    value - value of property
    
    Returns:
    
    self for method chaining
  - add
```
public Objects.ToStringHelper add(String name,
                                  double value)
```
    Adds a name/value pair to the formatted output in name=value format.
    
    Parameters:
    
    name - name of property
    
    value - value of property
    
    Returns:
    
    self for method chaining
  - add
```
public Objects.ToStringHelper add(String name,
                                  float value)
```
    Adds a name/value pair to the formatted output in name=value format.
    
    Parameters:
    
    name - name of property
    
    value - value of property
    
    Returns:
    
    self for method chaining
  - add
```
public Objects.ToStringHelper add(String name,
                                  int value)
```
    Adds a name/value pair to the formatted output in name=value format.
    
    Parameters:
    
    name - name of property
    
    value - value of property
    
    Returns:
    
    self for method chaining
  - add
```
public Objects.ToStringHelper add(String name,
                                  long value)
```
    Adds a name/value pair to the formatted output in name=value format.
    
    Parameters:
    
    name - name of property
    
    value - value of property
    
    Returns:
    
    self for method chaining
  - addValue
```
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.
    
    Parameters:
    
    value - value of property
    
    Returns:
    
    self for method chaining
  - addValue
```
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.
    
    Parameters:
    
    value - value of property
    
    Returns:
    
    self for method chaining
    
    Since:
    
    11.0 (source-compatible since 2.0)
  - addValue
```
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.
    
    Parameters:
    
    value - value of property
    
    Returns:
    
    self for method chaining
    
    Since:
    
    11.0 (source-compatible since 2.0)
  - addValue
```
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.
    
    Parameters:
    
    value - value of property
    
    Returns:
    
    self for method chaining
  - addValue
```
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.
    
    Parameters:
    
    value - value of property
    
    Returns:
    
    self for method chaining
    
    Since:
    
    11.0 (source-compatible since 2.0)
  - addValue
```
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.
    
    Parameters:
    
    value - value of property
    
    Returns:
    
    self for method chaining
  - addValue
```
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.
    
    Parameters:
    
    value - value of property
    
    Returns:
    
    self for method chaining
  - toString
```
public String toString()
```
    Returns a string in the format specified by Objects.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:
    
    toString in class Object
    
    Returns:
    
    never null
  - addHolder
```
private Objects.ToStringHelper.ValueHolder addHolder()
```
    Links a new Objects.ToStringHelper.ValueHolder to the tail of the values linked list and returns it.
    
    Returns:
    
    never null, always new instance
  - addHolder
```
private Objects.ToStringHelper addHolder(Object value)
```
    Adds an unnamed value to the formatted output.
    
    Parameters:
    
    value - value of property
    
    Returns:
    
    self for method chaining
  - addHolder
```
private Objects.ToStringHelper addHolder(String name,
                                         Object value)
```
    Adds an named value to the formatted output.
    
    Parameters:
    
    name - name of property
    
    value - value of property
    
    Returns:
    
    self for method chaining

Class Objects.ToStringHelper

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BUFFER_SIZE

className

holderHead

holderTail

omitNullValues

Constructor Detail

ToStringHelper

Method Detail

omitNullValues

add

add

add

add

add

add

add

addValue

addValue

addValue

addValue

addValue

addValue

addValue

toString

addHolder

addHolder

addHolder