Module org.pojomatic

Package org.pojomatic.formatter

Class DefaultEnhancedPojoFormatter

java.lang.Object

org.pojomatic.formatter.DefaultEnhancedPojoFormatter

All Implemented Interfaces:

EnhancedPojoFormatter, PojoFormatter

public class DefaultEnhancedPojoFormatter
extends Object
implements EnhancedPojoFormatter

Default formatter for classes that use Pojomatic. This implementation first presents the class name, and then each property in turn, separated by commas, using braces to indicate nesting.

For example, if a class Person has two properties, firstName and LastName, and these properties are using DefaultPropertyFormatter, then the Person instance representing Joe Blow would be represented as "Person{firstName: {Joe}, lastName: {Blow}}"

Since:

2.0

Constructor Summary

Constructors

Constructor	Description
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.
String	getPropertyPrefix(PropertyElement property)	Get the String prefix for a given PropertyElement.
String	getPropertySuffix(PropertyElement property)	Get the String suffix for a given PropertyElement.
String	getToStringPrefix(Class<?> pojoClass)	Get the String which should appear at the beginning of the result of toString().
String	getToStringSuffix(Class<?> pojoClass)	Get the String which should appear at the end of the result of toString().

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultEnhancedPojoFormatter

public DefaultEnhancedPojoFormatter()

Method Detail

getPropertyPrefix

public final String getPropertyPrefix(PropertyElement property)

Description copied from interface: PojoFormatter

Get the String prefix for a given PropertyElement. 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.

Specified by:

getPropertyPrefix in interface PojoFormatter

Parameters:

property - the property for which to generate a prefix

Returns:

the prefix for the given property

getPropertySuffix

public final String getPropertySuffix(PropertyElement property)

Description copied from interface: PojoFormatter

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

Specified by:

getPropertySuffix in interface PojoFormatter

Parameters:

property - the property for which to generate a suffix

Returns:

the suffix for the given property

getToStringPrefix

public final String getToStringPrefix(Class<?> pojoClass)

Description copied from interface: PojoFormatter

Get the String which should appear at the beginning of the result of toString().

Specified by:

getToStringPrefix in interface PojoFormatter

Parameters:

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

Returns:

the prefix to appear at the beginning of the result of toString()

See Also:

Object.toString()

getToStringSuffix

public final String getToStringSuffix(Class<?> pojoClass)

Description copied from interface: PojoFormatter

Get the String which should appear at the end of the result of toString().

Specified by:

getToStringSuffix in interface PojoFormatter

Parameters:

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

Returns:

the suffix to appear at the end of the result of toString()

See Also:

Object.toString()

appendToStringPrefix

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

Description copied from interface: EnhancedPojoFormatter

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

Specified by:

appendToStringPrefix in interface EnhancedPojoFormatter

Parameters:

builder - the builder to append to.

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

See Also:

Object.toString()

appendToStringSuffix

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

Description copied from interface: EnhancedPojoFormatter

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

Specified by:

appendToStringSuffix in interface EnhancedPojoFormatter

Parameters:

builder - the builder to append to.

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

See Also:

Object.toString()

appendPropertyPrefix

public void appendPropertyPrefix(StringBuilder builder,
                                 PropertyElement property)

Description copied from interface: EnhancedPojoFormatter

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.

Specified by:

appendPropertyPrefix in interface EnhancedPojoFormatter

Parameters:

builder - the builder to append to.

property - the property for which to generate a prefix

appendPropertySuffix

public void appendPropertySuffix(StringBuilder builder,
                                 PropertyElement property)

Description copied from interface: EnhancedPojoFormatter

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.

Specified by:

appendPropertySuffix in interface EnhancedPojoFormatter

Parameters:

builder - the builder to append to.

property - the property for which to generate a suffix