Package name.matthewgreet.strutscommons.policy

Class ValidationResult

java.lang.Object

name.matthewgreet.strutscommons.policy.ValidationResult

public class ValidationResult
extends Object

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

Constructor Summary

Constructors

Constructor	Description
ValidationResult()
ValidationResult(boolean success, String message, String messageKey, Required.MessageType messageType)

Method Summary

Modifier and Type	Method	Description
String	getMessage()	If validation failed, returns error message to use (if messageKey not set), or null to use annotation setting.
String	getMessageKey()	If validation failed, returns error message key to use, or null to use annotation setting.
Required.MessageType	getMessageType()	If validation failed, returns message list to use, or null to use annotation setting.
boolean	getShortCircuit()	If validation failed, returns whether to stop further validation of the same type.
boolean	getSuccess()
static ValidationResult	makeFailureResult()	Returns result for validation fail and using annotation message configuration.
static ValidationResult	makeFailureWithMessageKeyResult(String messageKey, Required.MessageType messageType)	Returns result for validation fail and using supplied message key.
static ValidationResult	makeFailureWithMessageResult(String message, Required.MessageType messageType)	Returns result for validation fail and using supplied message.
static ValidationResult	makeSuccessResult()	Returns result for validation pass.
void	setMessage(String message)
void	setMessageKey(String messageKey)
void	setMessageType(Required.MessageType messageType)
void	setShortCircuit(boolean shortCircuit)
void	setSuccess(boolean success)

Methods inherited from class java.lang.Object

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

Constructor Details

ValidationResult

public ValidationResult()

ValidationResult

public ValidationResult(boolean success,
 String message,
 String messageKey,
 Required.MessageType messageType)

Method Details

makeSuccessResult

public static ValidationResult makeSuccessResult()

Returns result for validation pass.

makeFailureResult

public static ValidationResult makeFailureResult()

Returns result for validation fail and using annotation message configuration.

makeFailureWithMessageResult

public static ValidationResult makeFailureWithMessageResult(String message,
 Required.MessageType messageType)

Returns result for validation fail and using supplied message.

makeFailureWithMessageKeyResult

public static ValidationResult makeFailureWithMessageKeyResult(String messageKey,
 Required.MessageType messageType)

Returns result for validation fail and using supplied message key.

getSuccess

public boolean getSuccess()

setSuccess

public void setSuccess(boolean success)

getMessage

public String getMessage()

If validation 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 validation 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 validation failed, returns message list to use, or null to use annotation setting.

setMessageType

public void setMessageType(Required.MessageType messageType)

getShortCircuit

public boolean getShortCircuit()

If validation failed, returns whether to stop further validation of the same type.

setShortCircuit

public void setShortCircuit(boolean shortCircuit)