net.sf.mmm.client.ui.base.feature

Class AbstractUiFeatureValueAndValidationWithValidators<VALUE>

java.lang.Object

net.sf.mmm.client.ui.base.feature.AbstractUiFeatureValueAndValidation<VALUE>

net.sf.mmm.client.ui.base.feature.AbstractUiFeatureValueAndValidationWithValidators<VALUE>

Type Parameters:

VALUE - is the generic type of the value.

All Implemented Interfaces:

AttributeReadValueAdvanced<VALUE>, AttributeWriteValueAdvanced<VALUE>, UiFeature, UiFeatureValidation<VALUE>, UiFeatureValue<VALUE>, UiFeatureValueAndValidation<VALUE>, AttributeReadValue<VALUE>, AttributeWriteValue<VALUE>, AbstractValidatableObject, HasValueValidators<VALUE>, ValidatableObject<VALUE>

Direct Known Subclasses:

AbstractUiDataBinding

public abstract class AbstractUiFeatureValueAndValidationWithValidators<VALUE>
extends AbstractUiFeatureValueAndValidation<VALUE>

This class extends AbstractUiFeatureValueAndValidation with the validators.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	mandatory
private List<ValueValidator<? super VALUE>>	validatorList

Constructor Summary

Constructors

Constructor and Description
AbstractUiFeatureValueAndValidationWithValidators() The constructor.

Method Summary

Modifier and Type	Method and Description
void	addValidator(ValueValidator<? super VALUE> validator) This method adds the given ValueValidator to this object.
boolean	doValidate(ValidationState state, VALUE value) This method performs the actual validation using the registered validators.
private void	ensureValidatorList() Ensures that the validator List is already created.
boolean	isMandatory() This method determines if ValidatorMandatory (or a sub-class) has been added to this object.
protected boolean	isMandatory(ValueValidator<?> validator) Determines the given validator is mandatory.
boolean	removeValidator(ValueValidator<? super VALUE> validator) This method removes the given ValueValidator from this object.
protected void	setMandatory(boolean mandatory)

Methods inherited from class net.sf.mmm.client.ui.base.feature.AbstractUiFeatureValueAndValidation

addValidatorMandatory, clearValidity, createValidationFailure, getLogger, getSource, getValue, getValueAndValidate, getValueOrException, handleGetValueError, resetValue, setValue, setValueForUser, toString, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureValueAndValidation

getValueDirect

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureValue

addChangeHandler, removeChangeHandler

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteValueAdvanced

setValue

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadValueAdvanced

getOriginalValue

Field Detail

validatorList

private List<ValueValidator<? super VALUE>> validatorList

See Also:

addValidator(ValueValidator)

mandatory

private boolean mandatory

See Also:

isMandatory()

Constructor Detail

AbstractUiFeatureValueAndValidationWithValidators

public AbstractUiFeatureValueAndValidationWithValidators()

The constructor.

Method Detail

isMandatory

public final boolean isMandatory()

This method determines if ValidatorMandatory (or a sub-class) has been added to this object.

Returns:

true if this the value of this object is mandatory.

setMandatory

protected void setMandatory(boolean mandatory)

Parameters:

mandatory - is the mandatory to set

addValidator

public final void addValidator(ValueValidator<? super VALUE> validator)

This method adds the given ValueValidator to this object. All ValueValidators are invoked in the same order as they are added by this method. They are invoked no matter if the previous ValueValidators failed or succeeded. You should always design ValueValidators in a robust and reusable way (e.g. a range validator should accept null as valid input so it can be used for both mandatory and optional fields).

Parameters:

validator - is the ValueValidator to add.

isMandatory

protected boolean isMandatory(ValueValidator<?> validator)

Determines the given validator is mandatory.

Parameters:

validator - the given ValueValidator.

Returns:

true if the given validator is mandatory.

ensureValidatorList

private void ensureValidatorList()

Ensures that the validator List is already created.

removeValidator

public final boolean removeValidator(ValueValidator<? super VALUE> validator)

This method removes the given ValueValidator from this object.
ATTENTION:
Having dynamic validators is an exotic case that should be avoided. This feature is provided but not recommended.

Parameters:

validator - is the ValueValidator to remove.

Returns:

true if the ValueValidator has actually been removed, false otherwise (it has NOT previously been added).

doValidate

public final boolean doValidate(ValidationState state,
                                VALUE value)

This method performs the actual validation using the registered validators. It is (indirectly) called from AbstractUiFeatureValueAndValidation.validate(ValidationState).

Parameters:

state - is the ValidationState. Must NOT be null.

value - is the current value of this object that has already be determined.

Returns:

true if the validation was successful, false otherwise (if there are validation failures).