Package name.matthewgreet.strutscommons.policy

Class CharacterConverter

java.lang.Object

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

name.matthewgreet.strutscommons.policy.AbstractConverterSupport<CharacterConversion,Character>

name.matthewgreet.strutscommons.policy.AbstractDefaultConverterSupport<CharacterConversion,Character>

name.matthewgreet.strutscommons.policy.CharacterConverter

All Implemented Interfaces:

Converter<CharacterConversion,Character>, DefaultPolicy, Policy<CharacterConversion>

public class CharacterConverter
extends AbstractDefaultConverterSupport<CharacterConversion,Character>

Constructor Summary

Constructors

Constructor	Description
CharacterConverter()

Method Summary

Modifier and Type	Method	Description
ConversionResult<Character>	convert(String formValue, Class<? extends Character> recipientClass)	Returns result of conversion of form field.
String	format(Character unformattedValue)	Returns single field value formatted for display in a 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.
Class<Character>	getRecipientClass()	Returns type of recipient fields that can receive converted form value.
String	getRecipientFieldName()	Returns name of field to receive converted form value, which can be empty string to use default.
protected CharacterConversion	makeDefaultAnnotation()

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

getAnnotation

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

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.Policy

setAnnotation

Constructor Details

CharacterConverter

public CharacterConverter()

Method Details

makeDefaultAnnotation

protected CharacterConversion makeDefaultAnnotation()

Specified by:

makeDefaultAnnotation in class AbstractDefaultConverterSupport<CharacterConversion,Character>

format

public String format(Character unformattedValue)
              throws Exception

Description copied from interface: Converter

Returns single field value formatted for display in a form field. Only applies single value recipients. Not called if the unformatted value is null, unless Converter.getProcessNoValue() returns true..

Throws:

Exception

getRecipientClass

public Class<Character> getRecipientClass()

Description copied from interface: Converter

Returns type of recipient fields that can receive converted form value.

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.

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.

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.

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.

convert

public ConversionResult<Character> convert(String formValue,
 Class<? extends Character> recipientClass)
                                    throws Exception

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.

Throws:

Exception

getProcessNoValue

public boolean getProcessNoValue()

Description copied from interface: Converter

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