Package name.matthewgreet.strutscommons.policy

Class StringCSVConverter

java.lang.Object

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

name.matthewgreet.strutscommons.policy.AbstractCollectionConverterSupport<StringCSVConversion,String>

name.matthewgreet.strutscommons.policy.AbstractDefaultCollectionConverterSupport<StringCSVConversion,String>

name.matthewgreet.strutscommons.policy.StringCSVConverter

All Implemented Interfaces:

CollectionConverter<StringCSVConversion,String>, DefaultPolicy, Policy<StringCSVConversion>

public class StringCSVConverter
extends AbstractDefaultCollectionConverterSupport<StringCSVConversion,String>

Constructor Summary

Constructors

Constructor	Description
StringCSVConverter()

Method Summary

Modifier and Type	Method	Description
ConversionResult<String>	convert(String formValue, Class<?> recipientFieldClass, Class<? extends String> recipientClass)	Returns result of conversion of form field.
String	format(Collection<String> unformattedValues)	Returns collection-based 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 or empty collection.
Class<String>	getRecipientClass()	Returns item types of recipient collection 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 StringCSVConversion	makeDefaultAnnotation()

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

getAnnotation, makeCollectionForRecipient

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

StringCSVConverter

public StringCSVConverter()

Method Details

makeDefaultAnnotation

protected StringCSVConversion makeDefaultAnnotation()

Specified by:

makeDefaultAnnotation in class AbstractDefaultCollectionConverterSupport<StringCSVConversion,String>

format

public String format(Collection<String> unformattedValues)
              throws Exception

Description copied from interface: CollectionConverter

Returns collection-based field value formatted for display in a form field. Not called if the unformatted value is null or empty collection, unless CollectionConverter.getProcessNoValue() returns true.

Throws:

Exception

getRecipientClass

public Class<String> getRecipientClass()

Description copied from interface: CollectionConverter

Returns item types of recipient collection fields that can receive converted form value. Not to be confused with collection type.

getMessageType

public Required.MessageType getMessageType()

Description copied from interface: CollectionConverter

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

getMessage

public String getMessage()

Description copied from interface: CollectionConverter

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

getMessageKey

public String getMessageKey()

Description copied from interface: CollectionConverter

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: CollectionConverter

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

convert

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

Description copied from interface: CollectionConverter

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

Throws:

Exception

getProcessNoValue

public boolean getProcessNoValue()

Description copied from interface: CollectionConverter

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