cz.ues.platform.commons.validation

Class GroupValidator

java.lang.Object

cz.ues.platform.commons.validation.GroupValidator

All Implemented Interfaces:

Validator

public class GroupValidator
extends java.lang.Object
implements Validator

Implementation of validator interface used to provide API for validating multiple validators at once.

Since:

UES6-00

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<Message>	messages List of validation failure messages.
private boolean	valid Flag whether some of inner validators failed.
private java.util.List<Validator>	validators List of validators.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GroupValidator() Creates new instance of group validator.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Validator aValidator) Adds new validator to collection of validations.
void	add(Validator aValidator, MessageCode aMsgCode, java.lang.String aMessage, java.lang.Object... aParameters) Adds new validator to collection of validations.
static GroupValidator	getInstance() Returns new instance of group validator.
Message	getMessage() Returns default message of validator.
java.util.List<Message>	getMessages() Returns all messages from validators contained in this group validator.
boolean	isValid() Performs validation and returns its result.
void	validate(java.lang.Class<? extends UESRuntimeException> aException) Performs validation and throws exception in case validation did not pass.
void	validate(ErrorCode aErrorCode, java.lang.String aMessage, java.lang.Object... aParameters) Performs validation and throws exception in case validation did not pass.

Methods inherited from class java.lang.Object

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

Field Detail

validators

private validators

List of validators.

messages

private messages

List of validation failure messages.

valid

private valid

Flag whether some of inner validators failed.

Constructor Detail

GroupValidator

protected GroupValidator()

Creates new instance of group validator.

Since:

UES6-00

Method Detail

getInstance

public static GroupValidator getInstance()

Returns new instance of group validator.

Returns:

New instance of group validator

Since:

UES6-00

add

public void add(Validator aValidator)

Adds new validator to collection of validations. Validator added by this method uses its default message in case validation did not pass.

Parameters:

aValidator - Validator to be added

Since:

UES6-00

add

public void add(Validator aValidator,
MessageCode aMsgCode,
java.lang.String aMessage,
java.lang.Object... aParameters)

Adds new validator to collection of validations. This method should be used to override default validator message used in case validation did not pass.

Parameters:

aValidator - Validator to be added

aMsgCode - Code of custom validation message

aMessage - Text of custom validation message

aParameters - Parameters of custom validation message

Since:

UES6-00

getMessages

public java.util.List<Message> getMessages()

Returns all messages from validators contained in this group validator. Only messages from validators which did not pass validation are returned.

Returns:

List of validator messages

Since:

UES6-00

getMessage

public Message getMessage()

Returns default message of validator.

Specified by:

getMessage in interface Validator

Returns:

Default message of validator

Since:

UES6-00

See Also:

Validator.getMessage()

isValid

public boolean isValid()

Performs validation and returns its result.

Specified by:

isValid in interface Validator

Returns:

true/false

Since:

UES6-00

See Also:

Validator.isValid()

validate

public void validate(java.lang.Class<? extends UESRuntimeException> aException)

Performs validation and throws exception in case validation did not pass.

Parameters:

aException - Class of exception to be thrown in case validation did not pass.

Since:

UES6-00

validate

public void validate(ErrorCode aErrorCode,
java.lang.String aMessage,
java.lang.Object... aParameters)

Performs validation and throws exception in case validation did not pass. Class of exception to be thrown is taken from instance of given error code (method getExceptionClass)

Specified by:

validate in interface Validator

Parameters:

aErrorCode - Code of custom validation message

aMessage - Text of custom validation message

aParameters - Parameters of custom validation message

Since:

UES6-00

See Also:

Validator#validate(Class, MessageCode, String, Object...)