Package com.helger.commons.string
Class ToStringGenerator
java.lang.Object
com.helger.commons.string.ToStringGenerator
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 -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionappendIf(String sField, boolean bValue, IBooleanPredicate aFilter) appendIf(String sField, boolean bValue, BooleanSupplier aFilter) appendIf(String sField, char cValue, ICharPredicate aFilter) appendIf(String sField, char cValue, BooleanSupplier aFilter) appendIf(String sField, double dValue, BooleanSupplier aFilter) appendIf(String sField, double dValue, DoublePredicate aFilter) appendIf(String sField, int nValue, BooleanSupplier aFilter) appendIf(String sField, int nValue, IntPredicate aFilter) appendIf(String sField, long nValue, BooleanSupplier aFilter) appendIf(String sField, long nValue, LongPredicate aFilter) appendIf(String sField, T aValue, BooleanSupplier aFilter) appendIfNotNull(String sField, Object aValue) appendPassword(String sField) appendPasswordIf(String sField, BooleanSupplier aFilter) static ToStringGeneratorgetDerived(String sSuperToString) Create aToStringGeneratorfor derived classes where the base class also uses theToStringGenerator.toString()Deprecated.
-
Field Details
-
CONSTANT_NULL
String to be emitted fornullvalues- See Also:
-
CONSTANT_THIS
String to be emitted forthisvalues- See Also:
-
CONSTANT_PASSWORD
String to be emited for password values- See Also:
-
-
Constructor Details
-
ToStringGenerator
-
-
Method Details
-
append
-
append
-
append
-
append
-
append
-
append
-
append
-
append
-
append
-
append
-
append
-
append
-
append
-
append
-
append
-
append
-
appendPassword
-
append
-
append
-
append
-
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
-
appendIf
@Nonnull public <T> ToStringGenerator appendIf(@Nonnull String sField, @Nullable T aValue, @Nonnull BooleanSupplier aFilter) -
appendIfNotNull
-
appendPasswordIf
-
getToString
-
toString
Deprecated.Don't call this; UsegetToString()instead -
getDerived
Create aToStringGeneratorfor derived classes where the base class also uses theToStringGenerator. This avoids that the implementing class name is emitted more than once.- Parameters:
sSuperToString- Always pass insuper.toString ()- Returns:
- Never
null
-
getToString()instead