Package name.matthewgreet.strutscommons.policy

Class AbstractCustomFormatterSupport<T>

java.lang.Object

name.matthewgreet.strutscommons.policy.AbstractPolicySupport<CustomConversion>

name.matthewgreet.strutscommons.policy.AbstractConverterSupport<CustomConversion,T>

name.matthewgreet.strutscommons.policy.AbstractCustomConverterSupport<T>

name.matthewgreet.strutscommons.policy.AbstractCustomFormatterSupport<T>

All Implemented Interfaces:

Converter<CustomConversion,T>, Policy<CustomConversion>

public abstract class AbstractCustomFormatterSupport<T>
extends AbstractCustomConverterSupport<T>

Template class for client supplied converters that just format for a view helper. Subclasses must implement Converter.getRecipientClass() and Converter.format(T).

Constructor Summary

Constructors

Constructor	Description
AbstractCustomFormatterSupport()

Method Summary

Modifier and Type	Method	Description
ConversionResult<T>	convert(String fieldValue, Class<? extends T> recipientClass)	Returns result of conversion of form field.
String	getMessage()	Returns message set by annotation.
String	getMessageKey()	Returns message key set by annotation, which is used to retrieve message from Action's TextProvider if it's not empty string.
Required.MessageType	getMessageType()	Returns whether to write any error message to action errors, field errors, or action messages.
String	getRecipientFieldName()	Returns name of field to receive converted form value, which can be empty string to use default.

Methods inherited from class name.matthewgreet.strutscommons.policy.AbstractCustomConverterSupport

getProcessNoValue

Methods inherited from class name.matthewgreet.strutscommons.policy.AbstractPolicySupport

getAnnotation, setAnnotation

Methods inherited from class java.lang.Object

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

Methods inherited from interface name.matthewgreet.strutscommons.policy.Converter

format, getRecipientClass

Methods inherited from interface name.matthewgreet.strutscommons.policy.Policy

getAnnotation, setAnnotation

Constructor Details

AbstractCustomFormatterSupport

public AbstractCustomFormatterSupport()

Method Details

convert

public ConversionResult<T> convert(String fieldValue,
 Class<? extends T> recipientClass)

Description copied from interface: Converter

Returns result of conversion of form field. This is not called if the form value is empty string or null, unless Converter.getProcessNoValue() returns true.

getRecipientFieldName

public String getRecipientFieldName()

Description copied from interface: Converter

Returns name of field to receive converted form value, which can be empty string to use default.

Specified by:

getRecipientFieldName in interface Converter<CustomConversion,T>

Overrides:

getRecipientFieldName in class AbstractCustomConverterSupport<T>

getMessageType

public Required.MessageType getMessageType()

Description copied from interface: Converter

Returns whether to write any error message to action errors, field errors, or action messages.

Specified by:

getMessageType in interface Converter<CustomConversion,T>

Overrides:

getMessageType in class AbstractCustomConverterSupport<T>

getMessage

public String getMessage()

Description copied from interface: Converter

Returns message set by annotation. Used if Converter.getMessageKey() is empty string or it fails to find a message.

Specified by:

getMessage in interface Converter<CustomConversion,T>

Overrides:

getMessage in class AbstractCustomConverterSupport<T>

getMessageKey

public String getMessageKey()

Description copied from interface: Converter

Returns message key set by annotation, which is used to retrieve message from Action's TextProvider if it's not empty string.

Specified by:

getMessageKey in interface Converter<CustomConversion,T>

Overrides:

getMessageKey in class AbstractCustomConverterSupport<T>