Module org.pojomatic

Package org.pojomatic.formatter

Interface EnhancedPojoFormatter

All Superinterfaces:

PojoFormatter

All Known Implementing Classes:

DefaultEnhancedPojoFormatter, EnhancedPojoFormatterWrapper

public interface EnhancedPojoFormatter
extends PojoFormatter

A formatter to aid in creating a String representation of a POJO. Any implementation of EnhancedPojoFormatter must have a public no-argument constructor. A new instance will be created for each time that Pojomator.doToString(Object) is called. Consequently, implementations do not need to be thread safe.

Since:

2.0

See Also:

DefaultEnhancedPojoFormatter

Method Summary

Modifier and Type	Method	Description
void	appendPropertyPrefix(StringBuilder builder, PropertyElement property)	Append the String prefix for a given PropertyElement to the supplied StringBuilder.
void	appendPropertySuffix(StringBuilder builder, PropertyElement property)	Append the String suffix for a given PropertyElement to the supplied StringBuilder.
void	appendToStringPrefix(StringBuilder builder, Class<?> pojoClass)	Append the String which should appear at the beginning of the result of toString() to the supplied StringBuilder.
void	appendToStringSuffix(StringBuilder builder, Class<?> pojoClass)	Append the String which should appear at the end of the result of toString() to the supplied StringBuilder.

Methods inherited from interface org.pojomatic.formatter.PojoFormatter

getPropertyPrefix, getPropertySuffix, getToStringPrefix, getToStringSuffix

Method Detail

appendToStringPrefix

void appendToStringPrefix(StringBuilder builder,
                          Class<?> pojoClass)

Append the String which should appear at the beginning of the result of toString() to the supplied StringBuilder.

Parameters:

builder - the builder to append to.

pojoClass - the class for which toString() is being called

See Also:

Object.toString()

appendToStringSuffix

void appendToStringSuffix(StringBuilder builder,
                          Class<?> pojoClass)

Append the String which should appear at the end of the result of toString() to the supplied StringBuilder.

Parameters:

builder - the builder to append to.

pojoClass - the class for which toString() is being called

See Also:

Object.toString()

appendPropertyPrefix

void appendPropertyPrefix(StringBuilder builder,
                          PropertyElement property)

Append the String prefix for a given PropertyElement to the supplied StringBuilder. This method will be called once for each property used in the result of toString(), in the order in which those properties will appear in that result, and before the call to PropertyFormatter.format(Object) for the property's value.

Parameters:

builder - the builder to append to.

property - the property for which to generate a prefix

appendPropertySuffix

void appendPropertySuffix(StringBuilder builder,
                          PropertyElement property)

Append the String suffix for a given PropertyElement to the supplied StringBuilder. This method will be called once after each call to PropertyFormatter.format(Object) for the property's value.

Parameters:

builder - the builder to append to.

property - the property for which to generate a suffix