Module org.pojomatic

Package org.pojomatic.formatter

Interface EnhancedPropertyFormatter

All Superinterfaces:

PropertyFormatter

All Known Implementing Classes:

DefaultEnhancedPropertyFormatter, EnhancedPropertyFormatterWrapper

public interface EnhancedPropertyFormatter
extends PropertyFormatter

A formatter for a property.

Any implementation of EnhancedPropertyFormatter must have a public no-argument constructor. A single instance will be created for each property; consequently, implementations must be thread safe.

Since:

2.0

See Also:

DefaultEnhancedPropertyFormatter

Method Summary

Modifier and Type	Method	Description
void	appendFormatted(StringBuilder builder, boolean b)	Format a boolean.
void	appendFormatted(StringBuilder builder, boolean[] booleans)	Format an array of booleans
void	appendFormatted(StringBuilder builder, byte b)	Format a byte
void	appendFormatted(StringBuilder builder, byte[] bytes)	Format an array of bytes
void	appendFormatted(StringBuilder builder, char c)	Format a character
void	appendFormatted(StringBuilder builder, char[] chars)	Format an array of characters
void	appendFormatted(StringBuilder builder, double d)	Format a double
void	appendFormatted(StringBuilder builder, double[] doubles)	Format an array of doubles
void	appendFormatted(StringBuilder builder, float f)	Format a float
void	appendFormatted(StringBuilder builder, float[] floats)	Format an array of floats
void	appendFormatted(StringBuilder builder, int i)	Format an integer
void	appendFormatted(StringBuilder builder, int[] ints)	Format an array of integers
void	appendFormatted(StringBuilder builder, long l)	Format a long
void	appendFormatted(StringBuilder builder, long[] longs)	Format an array of longs
void	appendFormatted(StringBuilder builder, short s)	Format a short
void	appendFormatted(StringBuilder builder, short[] shorts)	Format an array of shorts
void	appendFormatted(StringBuilder builder, Object o)	Format an object; no attempt will be made to format it as an array.
void	appendFormatted(StringBuilder builder, Object[] objects)	Format an array of Objects
void	appendFormattedPossibleArray(StringBuilder builder, Object o)	Format an object, which may be an array.
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 interface org.pojomatic.formatter.PropertyFormatter

format

Method Detail

initialize

void initialize(AnnotatedElement element)

Description copied from interface: PropertyFormatter

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 PropertyFormatter

Parameters:

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

appendFormatted

void appendFormatted(StringBuilder builder,
                     Object o)

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

Parameters:

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

o - the object to format

appendFormatted

void appendFormatted(StringBuilder builder,
                     boolean b)

Format a boolean.

Parameters:

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

b - the boolean to format

appendFormatted

void appendFormatted(StringBuilder builder,
                     byte b)

Format a byte

Parameters:

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

b - the byte to format

appendFormatted

void appendFormatted(StringBuilder builder,
                     short s)

Format a short

Parameters:

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

s - the short to format

appendFormatted

void appendFormatted(StringBuilder builder,
                     char c)

Format a character

Parameters:

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

c - the character to format

appendFormatted

void appendFormatted(StringBuilder builder,
                     int i)

Format an integer

Parameters:

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

i - the integer to format

appendFormatted

void appendFormatted(StringBuilder builder,
                     long l)

Format a long

Parameters:

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

l - the long to format

appendFormatted

void appendFormatted(StringBuilder builder,
                     float f)

Format a float

Parameters:

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

f - the float to format

appendFormatted

void appendFormatted(StringBuilder builder,
                     double d)

Format a double

Parameters:

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

d - the double to format

appendFormatted

void appendFormatted(StringBuilder builder,
                     boolean[] booleans)

Format an array of booleans

Parameters:

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

booleans - the array to format

appendFormatted

void appendFormatted(StringBuilder builder,
                     byte[] bytes)

Format an array of bytes

Parameters:

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

bytes - the array to format

appendFormatted

void appendFormatted(StringBuilder builder,
                     short[] shorts)

Format an array of shorts

Parameters:

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

shorts - the array to format

appendFormatted

void appendFormatted(StringBuilder builder,
                     char[] chars)

Format an array of characters

Parameters:

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

chars - the array to format

appendFormatted

void appendFormatted(StringBuilder builder,
                     int[] ints)

Format an array of integers

Parameters:

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

ints - the array to format

appendFormatted

void appendFormatted(StringBuilder builder,
                     long[] longs)

Format an array of longs

Parameters:

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

longs - the array to format

appendFormatted

void appendFormatted(StringBuilder builder,
                     float[] floats)

Format an array of floats

Parameters:

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

floats - the array to format

appendFormatted

void appendFormatted(StringBuilder builder,
                     double[] doubles)

Format an array of doubles

Parameters:

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

doubles - the array to format

appendFormatted

void appendFormatted(StringBuilder builder,
                     Object[] objects)

Format an array of Objects

Parameters:

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

objects - the array to format

appendFormattedPossibleArray

void appendFormattedPossibleArray(StringBuilder builder,
                                  Object o)

Format an object, which may be an array.

Parameters:

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

o - the object to format