de.bmiag.tapir.core.annotation.label

Class CustomLabelStringBuilder

java.lang.Object

de.bmiag.tapir.core.annotation.label.CustomLabelStringBuilder

public class CustomLabelStringBuilder
extends Object

Helps with the construction of good CustomLabeled.getCustomLabel() implementations.

You can customize the output using singleLine().

The builder will automatically handle cycles in the object tree. It also pretty prints arrays and Iterables.

The implementation and API is inspired by ToStringBuilder.

Since:

2.0.0

Author:

Nils Christian Ehmke <[email protected]>

Constructor Summary

Constructors

Constructor and Description
CustomLabelStringBuilder(Object instance)

Method Summary

Modifier and Type	Method and Description
CustomLabelStringBuilder	add(String fieldName, Object fieldValue)
CustomLabelStringBuilder	singleLine() Fields are printed on a single line, separated by commas instead of newlines
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomLabelStringBuilder

public CustomLabelStringBuilder(Object instance)

Parameters:

instance - the instance which's label should be built

Since:

2.0.0

Method Detail

singleLine

public CustomLabelStringBuilder singleLine()

Fields are printed on a single line, separated by commas instead of newlines

Returns:

this

Since:

2.0.0

add

public CustomLabelStringBuilder add(String fieldName,
                                    Object fieldValue)

Parameters:

fieldName - the field name to list the value under

fieldValue - the value to add to the output

Returns:

this

Since:

2.0.0

toString

public String toString()

Overrides:

toString in class Object