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

Methods

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	appendIfNotEmpty(String sField, boolean[] aValue)
ToStringGenerator	appendIfNotEmpty(String sField, byte[] aValue)
ToStringGenerator	appendIfNotEmpty(String sField, char[] aValue)
ToStringGenerator	appendIfNotEmpty(String sField, Collection<?> aValue)
ToStringGenerator	appendIfNotEmpty(String sField, double[] aValue)
ToStringGenerator	appendIfNotEmpty(String sField, float[] aValue)
ToStringGenerator	appendIfNotEmpty(String sField, int[] aValue)
ToStringGenerator	appendIfNotEmpty(String sField, long[] aValue)
ToStringGenerator	appendIfNotEmpty(String sField, Map<?,?> aValue)
ToStringGenerator	appendIfNotEmpty(String sField, Object[] aValue)
ToStringGenerator	appendIfNotEmpty(String sField, short[] aValue)
ToStringGenerator	appendIfNotNull(String sField, boolean[] aValue)
ToStringGenerator	appendIfNotNull(String sField, byte[] aValue)
ToStringGenerator	appendIfNotNull(String sField, char[] aValue)
ToStringGenerator	appendIfNotNull(String sField, double[] aValue)
ToStringGenerator	appendIfNotNull(String sField, float[] aValue)
ToStringGenerator	appendIfNotNull(String sField, int[] aValue)
ToStringGenerator	appendIfNotNull(String sField, long[] aValue)
ToStringGenerator	appendIfNotNull(String sField, Object aValue)
ToStringGenerator	appendIfNotNull(String sField, Object[] aValue)
ToStringGenerator	appendIfNotNull(String sField, short[] aValue)
ToStringGenerator	appendPassword(String sField)
static ToStringGenerator	getDerived(String sSuperToString) Create a ToStringGenerator for derived classes where the base class also uses the ToStringGenerator.
String	toString()

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)

appendIfNotNull

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

appendIfNotNull

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

appendIfNotNull

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

appendIfNotNull

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

appendIfNotNull

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

appendIfNotNull

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

appendIfNotNull

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

appendIfNotNull

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

appendIfNotNull

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

appendIfNotNull

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

appendIfNotEmpty

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

appendIfNotEmpty

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

appendIfNotEmpty

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

appendIfNotEmpty

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

appendIfNotEmpty

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

appendIfNotEmpty

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

appendIfNotEmpty

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

appendIfNotEmpty

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

appendIfNotEmpty

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

appendIfNotEmpty

@Nonnull
public ToStringGenerator appendIfNotEmpty(@Nonnull
                                         String sField,
                                         @Nullable
                                         Collection<?> aValue)

appendIfNotEmpty

@Nonnull
public ToStringGenerator appendIfNotEmpty(@Nonnull
                                         String sField,
                                         @Nullable
                                         Map<?,?> aValue)

toString

@Nonnull
public String toString()

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