Module org.pojomatic

Package org.pojomatic.formatter

Class DefaultEnhancedPropertyFormatter

java.lang.Object

org.pojomatic.formatter.DefaultEnhancedPropertyFormatter

All Implemented Interfaces:

EnhancedPropertyFormatter, PropertyFormatter

public class DefaultEnhancedPropertyFormatter
extends Object
implements EnhancedPropertyFormatter

The default property formatter used by Pojomatic. While the particulars of the formatting strategy are subject to change, the general principle is to provide a meaningful representation. In particular, arrays are formatted "deeply", rather than simply showing the default toString representation of Java arrays.

Since:

2.0

Constructor Summary

Constructors

Constructor	Description
DefaultEnhancedPropertyFormatter()

Method Summary

Modifier and Type	Method	Description
void	appendFormatted(StringBuilder builder, boolean b)	Format a boolean.
void	appendFormatted(StringBuilder builder, boolean[] array)	Format an array of booleans
void	appendFormatted(StringBuilder builder, byte b)	Format a byte
void	appendFormatted(StringBuilder builder, byte[] array)	Format an array of bytes
void	appendFormatted(StringBuilder builder, char c)	Format a character
void	appendFormatted(StringBuilder builder, char[] array)	Format an array of characters
void	appendFormatted(StringBuilder builder, double d)	Format a double
void	appendFormatted(StringBuilder builder, double[] array)	Format an array of doubles
void	appendFormatted(StringBuilder builder, float f)	Format a float
void	appendFormatted(StringBuilder builder, float[] array)	Format an array of floats
void	appendFormatted(StringBuilder builder, int i)	Format an integer
void	appendFormatted(StringBuilder builder, int[] array)	Format an array of integers
void	appendFormatted(StringBuilder builder, long l)	Format a long
void	appendFormatted(StringBuilder builder, long[] array)	Format an array of longs
void	appendFormatted(StringBuilder builder, short s)	Format a short
void	appendFormatted(StringBuilder builder, short[] array)	Format an array of shorts
void	appendFormatted(StringBuilder builder, Object value)	Format an object; no attempt will be made to format it as an array.
void	appendFormatted(StringBuilder builder, Object[] array)	Format an array of Objects
void	appendFormattedPossibleArray(StringBuilder builder, Object value)	Format an object, which may be an array.
String	format(Object value)	Format a given value.
void	initialize(AnnotatedElement element)	Initialize the formatter for use; this method will be called exactly once on an instance, prior to any calls to PropertyFormatter.format(Object).

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultEnhancedPropertyFormatter

public DefaultEnhancedPropertyFormatter()

Method Detail

initialize

public void initialize(AnnotatedElement element)

Initialize the formatter for use; this method will be called exactly once on an instance, prior to any calls to PropertyFormatter.format(Object). This method does not need to be thread-safe. A typical implementation might inspect the element for additional annotations used to configure the formatter.

Specified by:

initialize in interface EnhancedPropertyFormatter

Specified by:

initialize in interface PropertyFormatter

Parameters:

element - the field or method this formatter will be used for.

format

public final String format(Object value)

Description copied from interface: PropertyFormatter

Format a given value. This method must be thread safe.

Specified by:

format in interface PropertyFormatter

Parameters:

value - the value to format

Returns:

the value, formatted (must not be null)

appendFormatted

public void appendFormatted(StringBuilder builder,
                            Object value)

Description copied from interface: EnhancedPropertyFormatter

Format an object; no attempt will be made to format it as an array.

Specified by:

appendFormatted in interface EnhancedPropertyFormatter

Parameters:

builder - the builder to append the formatted representation of the object to

value - the object to format

appendFormattedPossibleArray

public void appendFormattedPossibleArray(StringBuilder builder,
                                         Object value)

Description copied from interface: EnhancedPropertyFormatter

Format an object, which may be an array.

Specified by:

appendFormattedPossibleArray in interface EnhancedPropertyFormatter

Parameters:

builder - the builder to append the formatted representation of the object to

value - the object to format

appendFormatted

public void appendFormatted(StringBuilder builder,
                            Object[] array)

Description copied from interface: EnhancedPropertyFormatter

Format an array of Objects

Specified by:

appendFormatted in interface EnhancedPropertyFormatter

Parameters:

builder - the builder to append the formatted representation of the array to

array - the array to format

appendFormatted

public void appendFormatted(StringBuilder builder,
                            boolean b)

Description copied from interface: EnhancedPropertyFormatter

Format a boolean.

Specified by:

appendFormatted in interface EnhancedPropertyFormatter

Parameters:

builder - the builder to append the formatted representation of the boolean to

b - the boolean to format

appendFormatted

public void appendFormatted(StringBuilder builder,
                            byte b)

Description copied from interface: EnhancedPropertyFormatter

Format a byte

Specified by:

appendFormatted in interface EnhancedPropertyFormatter

Parameters:

builder - the builder to append the formatted representation of the byte to

b - the byte to format

appendFormatted

public void appendFormatted(StringBuilder builder,
                            short s)

Description copied from interface: EnhancedPropertyFormatter

Format a short

Specified by:

appendFormatted in interface EnhancedPropertyFormatter

Parameters:

builder - the builder to append the formatted representation of the short to

s - the short to format

appendFormatted

public void appendFormatted(StringBuilder builder,
                            char c)

Description copied from interface: EnhancedPropertyFormatter

Format a character

Specified by:

appendFormatted in interface EnhancedPropertyFormatter

Parameters:

builder - the builder to append the formatted representation of the character to

c - the character to format

appendFormatted

public void appendFormatted(StringBuilder builder,
                            int i)

Description copied from interface: EnhancedPropertyFormatter

Format an integer

Specified by:

appendFormatted in interface EnhancedPropertyFormatter

Parameters:

builder - the builder to append the formatted representation of the integer to

i - the integer to format

appendFormatted

public void appendFormatted(StringBuilder builder,
                            long l)

Description copied from interface: EnhancedPropertyFormatter

Format a long

Specified by:

appendFormatted in interface EnhancedPropertyFormatter

Parameters:

builder - the builder to append the formatted representation of the long to

l - the long to format

appendFormatted

public void appendFormatted(StringBuilder builder,
                            float f)

Description copied from interface: EnhancedPropertyFormatter

Format a float

Specified by:

appendFormatted in interface EnhancedPropertyFormatter

Parameters:

builder - the builder to append the formatted representation of the float to

f - the float to format

appendFormatted

public void appendFormatted(StringBuilder builder,
                            double d)

Description copied from interface: EnhancedPropertyFormatter

Format a double

Specified by:

appendFormatted in interface EnhancedPropertyFormatter

Parameters:

builder - the builder to append the formatted representation of the double to

d - the double to format

appendFormatted

public void appendFormatted(StringBuilder builder,
                            boolean[] array)

Description copied from interface: EnhancedPropertyFormatter

Format an array of booleans

Specified by:

appendFormatted in interface EnhancedPropertyFormatter

Parameters:

builder - the builder to append the formatted representation of the array to

array - the array to format

appendFormatted

public void appendFormatted(StringBuilder builder,
                            byte[] array)

Description copied from interface: EnhancedPropertyFormatter

Format an array of bytes

Specified by:

appendFormatted in interface EnhancedPropertyFormatter

Parameters:

builder - the builder to append the formatted representation of the array to

array - the array to format

appendFormatted

public void appendFormatted(StringBuilder builder,
                            short[] array)

Description copied from interface: EnhancedPropertyFormatter

Format an array of shorts

Specified by:

appendFormatted in interface EnhancedPropertyFormatter

Parameters:

builder - the builder to append the formatted representation of the array to

array - the array to format

appendFormatted

public void appendFormatted(StringBuilder builder,
                            char[] array)

Description copied from interface: EnhancedPropertyFormatter

Format an array of characters

Specified by:

appendFormatted in interface EnhancedPropertyFormatter

Parameters:

builder - the builder to append the formatted representation of the array to

array - the array to format

appendFormatted

public void appendFormatted(StringBuilder builder,
                            int[] array)

Description copied from interface: EnhancedPropertyFormatter

Format an array of integers

Specified by:

appendFormatted in interface EnhancedPropertyFormatter

Parameters:

builder - the builder to append the formatted representation of the array to

array - the array to format

appendFormatted

public void appendFormatted(StringBuilder builder,
                            long[] array)

Description copied from interface: EnhancedPropertyFormatter

Format an array of longs

Specified by:

appendFormatted in interface EnhancedPropertyFormatter

Parameters:

builder - the builder to append the formatted representation of the array to

array - the array to format

appendFormatted

public void appendFormatted(StringBuilder builder,
                            float[] array)

Description copied from interface: EnhancedPropertyFormatter

Format an array of floats

Specified by:

appendFormatted in interface EnhancedPropertyFormatter

Parameters:

builder - the builder to append the formatted representation of the array to

array - the array to format

appendFormatted

public void appendFormatted(StringBuilder builder,
                            double[] array)

Description copied from interface: EnhancedPropertyFormatter

Format an array of doubles

Specified by:

appendFormatted in interface EnhancedPropertyFormatter

Parameters:

builder - the builder to append the formatted representation of the array to

array - the array to format