Module org.pojomatic

Package org.pojomatic.formatter

Interface PojoFormatter

All Known Subinterfaces:

EnhancedPojoFormatter

All Known Implementing Classes:

DefaultEnhancedPojoFormatter, DefaultPojoFormatter, EnhancedPojoFormatterWrapper

Deprecated.

Since 2.0. Use EnhancedPojoFormatter instead. Use of this interface typically requires creating additional StringBuidler instances.

@Deprecated
public interface PojoFormatter

A formatter to aid in creating a String representation of a POJO. A new instance will be created for each time that Pojomator.doToString(Object) is called.

Method Summary

Modifier and Type	Method	Description
String	getPropertyPrefix(PropertyElement property)	Deprecated. Use EnhancedPojoFormatter.appendPropertyPrefix(StringBuilder, PropertyElement)
String	getPropertySuffix(PropertyElement property)	Deprecated. Use EnhancedPojoFormatter.appendPropertySuffix(StringBuilder, PropertyElement)
String	getToStringPrefix(Class<?> pojoClass)	Deprecated. Use EnhancedPojoFormatter.appendToStringPrefix(StringBuilder, Class) instead
String	getToStringSuffix(Class<?> pojoClass)	Deprecated. Use EnhancedPojoFormatter.appendToStringSuffix(StringBuilder, Class) instead

Method Detail

getToStringPrefix

@Deprecated
String getToStringPrefix(Class<?> pojoClass)

Deprecated. Use EnhancedPojoFormatter.appendToStringPrefix(StringBuilder, Class) instead

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

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

@Deprecated
String getToStringSuffix(Class<?> pojoClass)

Deprecated. Use EnhancedPojoFormatter.appendToStringSuffix(StringBuilder, Class) instead

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

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()

getPropertyPrefix

@Deprecated
String getPropertyPrefix(PropertyElement property)

Deprecated. Use EnhancedPojoFormatter.appendPropertyPrefix(StringBuilder, PropertyElement)

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.

Parameters:

property - the property for which to generate a prefix

Returns:

the prefix for the given property

getPropertySuffix

@Deprecated
String getPropertySuffix(PropertyElement property)

Deprecated. Use EnhancedPojoFormatter.appendPropertySuffix(StringBuilder, PropertyElement)

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.

Parameters:

property - the property for which to generate a suffix

Returns:

the suffix for the given property