Package name.matthewgreet.strutscommons.policy

Class AbstractCustomListFormatterSupport<T>

java.lang.Object

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

name.matthewgreet.strutscommons.policy.AbstractListConverterSupport<CustomListConversion,T>

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

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

All Implemented Interfaces:

ListConverter<CustomListConversion,T>, Policy<CustomListConversion>

public abstract class AbstractCustomListFormatterSupport<T>
extends AbstractCustomListConverterSupport<T>

Template class for custom list converters that just format for a view helper. Subclasses must implement ListConverter.getRecipientClass() and #format.

Constructor Summary

Constructors

Constructor	Description
AbstractCustomListFormatterSupport()

Method Summary

Modifier and Type	Method	Description
ConversionResult<T>	convert(String formValue, Class<?> recipientFieldClass, 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.
boolean	getProcessNoValue()	Returns whether #convert converts empty string value, and #format formats null value or empty collection.
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.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.ListConverter

format, getRecipientClass

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

getAnnotation, setAnnotation

Constructor Details

AbstractCustomListFormatterSupport

public AbstractCustomListFormatterSupport()

Method Details

convert

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

Description copied from interface: ListConverter

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

getRecipientFieldName

public String getRecipientFieldName()

Description copied from interface: ListConverter

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

Specified by:

getRecipientFieldName in interface ListConverter<CustomListConversion,T>

Overrides:

getRecipientFieldName in class AbstractCustomListConverterSupport<T>

getMessageType

public Required.MessageType getMessageType()

Description copied from interface: ListConverter

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

Specified by:

getMessageType in interface ListConverter<CustomListConversion,T>

Overrides:

getMessageType in class AbstractCustomListConverterSupport<T>

getMessage

public String getMessage()

Description copied from interface: ListConverter

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

Specified by:

getMessage in interface ListConverter<CustomListConversion,T>

Overrides:

getMessage in class AbstractCustomListConverterSupport<T>

getMessageKey

public String getMessageKey()

Description copied from interface: ListConverter

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 ListConverter<CustomListConversion,T>

Overrides:

getMessageKey in class AbstractCustomListConverterSupport<T>

getProcessNoValue

public boolean getProcessNoValue()

Description copied from interface: ListConverter

Returns whether #convert converts empty string value, and #format formats null value or empty collection.

Specified by:

getProcessNoValue in interface ListConverter<CustomListConversion,T>

Overrides:

getProcessNoValue in class AbstractCustomListConverterSupport<T>