com.helger.commons.string

Class ToStringGenerator

java.lang.Object

com.helger.commons.string.ToStringGenerator

@NotThreadSafe
public final class ToStringGenerator
extends Object

This is a utility class for easier toString method creations. It assumes that the toString method is only used for the representation of the internal state and not for creating human readable formats.

A real world example for a final class derived from Object or a base class looks like this:

 @Override
 public String toString ()
 {
   return new ToStringGenerator (this).append ("member1", member1).append ("member2", member2).toString ();
 }
 

For a derived class, the typical code looks like this, assuming that the base class also used the ToStringGenerator:

 @Override
 public String toString ()
 {
   return ToStringGenerator.getDerived (super.toString ())
                           .append ("member3", member3)
                           .append ("member4", member4)
                           .toString ();
 }
 

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONSTANT_NULL String to be emitted for null values
static String	CONSTANT_PASSWORD String to be emited for password values
static String	CONSTANT_THIS String to be emitted for this values

Constructor Summary

Constructors

Constructor and Description
ToStringGenerator(Object aSrc)

Method Summary

Modifier and Type	Method and Description
ToStringGenerator	append(String sField, boolean aValue)
ToStringGenerator	append(String sField, boolean[] aValue)
ToStringGenerator	append(String sField, byte aValue)
ToStringGenerator	append(String sField, byte[] aValue)
ToStringGenerator	append(String sField, char aValue)
ToStringGenerator	append(String sField, char[] aValue)
ToStringGenerator	append(String sField, double aValue)
ToStringGenerator	append(String sField, double[] aValue)
ToStringGenerator	append(String sField, Enum<?> aValue)
ToStringGenerator	append(String sField, float aValue)
ToStringGenerator	append(String sField, float[] aValue)
ToStringGenerator	append(String sField, int aValue)
ToStringGenerator	append(String sField, int[] aValue)
ToStringGenerator	append(String sField, long aValue)
ToStringGenerator	append(String sField, long[] aValue)
ToStringGenerator	append(String sField, Object aValue)
ToStringGenerator	append(String sField, Object[] aValue)
ToStringGenerator	append(String sField, short aValue)
ToStringGenerator	append(String sField, short[] aValue)
ToStringGenerator	appendIf(String sField, boolean bValue, BooleanSupplier aFilter)
ToStringGenerator	appendIf(String sField, boolean bValue, IBooleanPredicate aFilter)
ToStringGenerator	appendIf(String sField, char cValue, BooleanSupplier aFilter)
ToStringGenerator	appendIf(String sField, char cValue, ICharPredicate aFilter)
ToStringGenerator	appendIf(String sField, double dValue, BooleanSupplier aFilter)
ToStringGenerator	appendIf(String sField, double dValue, DoublePredicate aFilter)
ToStringGenerator	appendIf(String sField, int nValue, BooleanSupplier aFilter)
ToStringGenerator	appendIf(String sField, int nValue, IntPredicate aFilter)
ToStringGenerator	appendIf(String sField, long nValue, BooleanSupplier aFilter)
ToStringGenerator	appendIf(String sField, long nValue, LongPredicate aFilter)
<T> ToStringGenerator	appendIf(String sField, T aValue, BooleanSupplier aFilter)
<T> ToStringGenerator	appendIf(String sField, T aValue, Predicate<? super T> aFilter)
ToStringGenerator	appendIfNotNull(String sField, Object aValue)
ToStringGenerator	appendPassword(String sField)
ToStringGenerator	appendPasswordIf(String sField, BooleanSupplier aFilter)
static ToStringGenerator	getDerived(String sSuperToString) Create a ToStringGenerator for derived classes where the base class also uses the ToStringGenerator.
String	getToString()
String	toString() Deprecated. Use getToString() instead

Methods inherited from class java.lang.Object

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

Field Detail

CONSTANT_NULL

public static final String CONSTANT_NULL

String to be emitted for null values

See Also:

Constant Field Values

CONSTANT_THIS

public static final String CONSTANT_THIS

String to be emitted for this values

See Also:

Constant Field Values

CONSTANT_PASSWORD

public static final String CONSTANT_PASSWORD

String to be emited for password values

See Also:

Constant Field Values

Constructor Detail

ToStringGenerator

public ToStringGenerator(@Nullable
                         Object aSrc)

Method Detail

append

@Nonnull
public ToStringGenerator append(@Nonnull
                                          String sField,
                                          boolean aValue)

append

@Nonnull
public ToStringGenerator append(@Nonnull
                                          String sField,
                                          @Nullable
                                          boolean[] aValue)

append

@Nonnull
public ToStringGenerator append(@Nonnull
                                          String sField,
                                          byte aValue)

append

@Nonnull
public ToStringGenerator append(@Nonnull
                                          String sField,
                                          @Nullable
                                          byte[] aValue)

append

@Nonnull
public ToStringGenerator append(@Nonnull
                                          String sField,
                                          char aValue)

append

@Nonnull
public ToStringGenerator append(@Nonnull
                                          String sField,
                                          @Nullable
                                          char[] aValue)

append

@Nonnull
public ToStringGenerator append(@Nonnull
                                          String sField,
                                          double aValue)

append

@Nonnull
public ToStringGenerator append(@Nonnull
                                          String sField,
                                          @Nullable
                                          double[] aValue)

append

@Nonnull
public ToStringGenerator append(@Nonnull
                                          String sField,
                                          float aValue)

append

@Nonnull
public ToStringGenerator append(@Nonnull
                                          String sField,
                                          @Nullable
                                          float[] aValue)

append

@Nonnull
public ToStringGenerator append(@Nonnull
                                          String sField,
                                          int aValue)

append

@Nonnull
public ToStringGenerator append(@Nonnull
                                          String sField,
                                          @Nullable
                                          int[] aValue)

append

@Nonnull
public ToStringGenerator append(@Nonnull
                                          String sField,
                                          long aValue)

append

@Nonnull
public ToStringGenerator append(@Nonnull
                                          String sField,
                                          @Nullable
                                          long[] aValue)

append

@Nonnull
public ToStringGenerator append(@Nonnull
                                          String sField,
                                          short aValue)

append

@Nonnull
public ToStringGenerator append(@Nonnull
                                          String sField,
                                          @Nullable
                                          short[] aValue)

appendPassword

@Nonnull
public ToStringGenerator appendPassword(@Nonnull
                                                  String sField)

append

@Nonnull
public ToStringGenerator append(@Nonnull
                                          String sField,
                                          @Nullable
                                          Enum<?> aValue)

append

@Nonnull
public ToStringGenerator append(@Nonnull
                                          String sField,
                                          @Nullable
                                          Object aValue)

append

@Nonnull
public ToStringGenerator append(@Nonnull
                                          String sField,
                                          @Nullable
                                          Object[] aValue)

appendIf

@Nonnull
public ToStringGenerator appendIf(@Nonnull
                                            String sField,
                                            boolean bValue,
                                            @Nonnull
                                            IBooleanPredicate aFilter)

appendIf

@Nonnull
public ToStringGenerator appendIf(@Nonnull
                                            String sField,
                                            boolean bValue,
                                            @Nonnull
                                            BooleanSupplier aFilter)

appendIf

@Nonnull
public ToStringGenerator appendIf(@Nonnull
                                            String sField,
                                            char cValue,
                                            @Nonnull
                                            ICharPredicate aFilter)

appendIf

@Nonnull
public ToStringGenerator appendIf(@Nonnull
                                            String sField,
                                            char cValue,
                                            @Nonnull
                                            BooleanSupplier aFilter)

appendIf

@Nonnull
public ToStringGenerator appendIf(@Nonnull
                                            String sField,
                                            int nValue,
                                            @Nonnull
                                            IntPredicate aFilter)

appendIf

@Nonnull
public ToStringGenerator appendIf(@Nonnull
                                            String sField,
                                            int nValue,
                                            @Nonnull
                                            BooleanSupplier aFilter)

appendIf

@Nonnull
public ToStringGenerator appendIf(@Nonnull
                                            String sField,
                                            long nValue,
                                            @Nonnull
                                            LongPredicate aFilter)

appendIf

@Nonnull
public ToStringGenerator appendIf(@Nonnull
                                            String sField,
                                            long nValue,
                                            @Nonnull
                                            BooleanSupplier aFilter)

appendIf

@Nonnull
public ToStringGenerator appendIf(@Nonnull
                                            String sField,
                                            double dValue,
                                            @Nonnull
                                            DoublePredicate aFilter)

appendIf

@Nonnull
public ToStringGenerator appendIf(@Nonnull
                                            String sField,
                                            double dValue,
                                            @Nonnull
                                            BooleanSupplier aFilter)

appendIf

@Nonnull
public <T> ToStringGenerator appendIf(@Nonnull
                                                String sField,
                                                @Nullable
                                                T aValue,
                                                @Nonnull
                                                Predicate<? super T> aFilter)

appendIf

@Nonnull
public <T> ToStringGenerator appendIf(@Nonnull
                                                String sField,
                                                @Nullable
                                                T aValue,
                                                @Nonnull
                                                BooleanSupplier aFilter)

appendIfNotNull

@Nonnull
public ToStringGenerator appendIfNotNull(@Nonnull
                                                   String sField,
                                                   @Nullable
                                                   Object aValue)

appendPasswordIf

@Nonnull
public ToStringGenerator appendPasswordIf(@Nonnull
                                                    String sField,
                                                    BooleanSupplier aFilter)

getToString

@Nonnull
public String getToString()

toString

@Nonnull
 @Deprecated
public String toString()

Deprecated. Use getToString() instead

Overrides:

toString in class Object

getDerived

@Nonnull
public static ToStringGenerator getDerived(@Nonnull
                                                     String sSuperToString)

Create a ToStringGenerator for derived classes where the base class also uses the ToStringGenerator. This avoids that the implementing class name is emitted more than once.

Parameters:

sSuperToString - Always pass in super.toString ()

Returns:

Never null