Package name.matthewgreet.strutscommons.policy

Class ConversionResult<T>

java.lang.Object

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

public class ConversionResult<T>
extends Object

Describes result of a conversion. Clients should use static methods starting with 'make'.

Field Summary

Fields

Modifier and Type	Field	Description
String	message
String	messageKey
Required.MessageType	messageType

Constructor Summary

Constructors

Constructor	Description
ConversionResult()
ConversionResult(boolean success, T parsedValue, Collection<T> parsedCollectionValue, String message, String messageKey, Required.MessageType messageType)

Method Summary

Modifier and Type	Method	Description
String	getMessage()	If conversion failed, returns error message to use (if messageKey not set), or null to use annotation setting.
String	getMessageKey()	If conversion failed, returns error message key to use, or null to use annotation setting.
Required.MessageType	getMessageType()	If conversion failed, returns message list to use, or null to use annotation setting.
Collection<T>	getParsedCollectionValue()
T	getParsedValue()
boolean	getSuccess()
static <T> ConversionResult<T>	makeFailureResult()	Returns result for failed conversion and using annotation message configuration.
static <T> ConversionResult<T>	makeFailureWithMessageKeyResult(String messageKey, Required.MessageType messageType)	Returns result for failed conversion and using supplied message key.
static <T> ConversionResult<T>	makeFailureWithMessageResult(String message, Required.MessageType messageType)	Returns result for failed conversion and using supplied message.
static <T> ConversionResult<T>	makeSkippedCollectionResult(Collection<T> emptyCollection)	Returns result for when field value is an empty string, skipping collection-based conversion.
static <T> ConversionResult<T>	makeSkippedResult()	Returns result for when field value is an empty string, skipping single value conversion.
static <T> ConversionResult<T>	makeSuccessCollectionResult(Collection<T> parsedValue)	Returns result for successful collection-based conversion.
static <T> ConversionResult<T>	makeSuccessResult(T parsedValue)	Returns result for successful single value conversion.
void	setMessage(String message)
void	setMessageKey(String messageKey)
void	setMessageType(Required.MessageType messageType)
void	setParsedCollectionValue(Collection<T> parsedCollectionValue)
void	setParsedValue(T parsedValue)
void	setSuccess(boolean success)

Methods inherited from class java.lang.Object

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

Field Details

message

public String message

messageKey

public String messageKey

messageType

public Required.MessageType messageType

Constructor Details

ConversionResult

public ConversionResult()

ConversionResult

public ConversionResult(boolean success,
 T parsedValue,
 Collection<T> parsedCollectionValue,
 String message,
 String messageKey,
 Required.MessageType messageType)

Method Details

makeSkippedCollectionResult

public static <T> ConversionResult<T> makeSkippedCollectionResult(Collection<T> emptyCollection)

Returns result for when field value is an empty string, skipping collection-based conversion.

makeSkippedResult

public static <T> ConversionResult<T> makeSkippedResult()

Returns result for when field value is an empty string, skipping single value conversion.

makeSuccessCollectionResult

public static <T> ConversionResult<T> makeSuccessCollectionResult(Collection<T> parsedValue)

Returns result for successful collection-based conversion.

makeSuccessResult

public static <T> ConversionResult<T> makeSuccessResult(T parsedValue)

Returns result for successful single value conversion.

makeFailureResult

public static <T> ConversionResult<T> makeFailureResult()

Returns result for failed conversion and using annotation message configuration.

makeFailureWithMessageResult

public static <T> ConversionResult<T> makeFailureWithMessageResult(String message,
 Required.MessageType messageType)

Returns result for failed conversion and using supplied message.

makeFailureWithMessageKeyResult

public static <T> ConversionResult<T> makeFailureWithMessageKeyResult(String messageKey,
 Required.MessageType messageType)

Returns result for failed conversion and using supplied message key.

getSuccess

public boolean getSuccess()

setSuccess

public void setSuccess(boolean success)

getParsedValue

public T getParsedValue()

setParsedValue

public void setParsedValue(T parsedValue)

getParsedCollectionValue

public Collection<T> getParsedCollectionValue()

setParsedCollectionValue

public void setParsedCollectionValue(Collection<T> parsedCollectionValue)

getMessage

public String getMessage()

If conversion failed, returns error message to use (if messageKey not set), or null to use annotation setting.

setMessage

public void setMessage(String message)

getMessageKey

public String getMessageKey()

If conversion failed, returns error message key to use, or null to use annotation setting.

setMessageKey

public void setMessageKey(String messageKey)

getMessageType

public Required.MessageType getMessageType()

If conversion failed, returns message list to use, or null to use annotation setting.

setMessageType

public void setMessageType(Required.MessageType messageType)