com.vaadin.data
Interface Validatable

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
BufferedValidatable, Field<T>
All Known Implementing Classes:
AbstractField, AbstractSelect, AbstractTextField, CheckBox, ComboBox, CustomField, DateField, Form, InlineDateField, ListSelect, NativeSelect, OptionGroup, PasswordField, PopupDateField, ProgressIndicator, RichTextArea, Select, Slider, Table, TextArea, TextField, Tree, TreeTable, TwinColSelect

public interface Validatable
extends java.io.Serializable

Interface for validatable objects. Defines methods to verify if the object's value is valid or not, and to add, remove and list registered validators of the object.

Since:
3.0
Author:
Vaadin Ltd.
See Also:
Validator

Method Summary
 void addValidator(Validator validator)
           Adds a new validator for this object.
 java.util.Collection<Validator> getValidators()
           Returns a collection of all validators currently registered for the object.
 boolean isInvalidAllowed()
           Checks the validabtable object accept invalid values.The default value is true.
 boolean isValid()
           Tests the current value of the object against all registered validators.
 void removeAllValidators()
          Removes all validators from this object, as if removeValidator was called for each registered validator.
 void removeValidator(Validator validator)
           Removes a previously registered validator from the object.
 void setInvalidAllowed(boolean invalidValueAllowed)
           Should the validabtable object accept invalid values.
 void validate()
           Checks the validity of the validatable.
 

Method Detail

addValidator

void addValidator(Validator validator)

Adds a new validator for this object. The validator's Validator.validate(Object) method is activated every time the object's value needs to be verified, that is, when the isValid() method is called. This usually happens when the object's value changes.

Parameters:
validator - the new validator

removeValidator

void removeValidator(Validator validator)

Removes a previously registered validator from the object. The specified validator is removed from the object and its validate method is no longer called in isValid().

Parameters:
validator - the validator to remove

removeAllValidators

void removeAllValidators()
Removes all validators from this object, as if removeValidator was called for each registered validator.


getValidators

java.util.Collection<Validator> getValidators()

Returns a collection of all validators currently registered for the object. The collection may be immutable. Calling removeValidator for this Validatable while iterating over the collection may be unsafe (e.g. may throw ConcurrentModificationException.)

Returns:
A collection of validators

isValid

boolean isValid()

Tests the current value of the object against all registered validators. The registered validators are iterated and for each the Validator.validate(Object) method is called. If any validator throws the Validator.InvalidValueException this method returns false.

Returns:
true if the registered validators concur that the value is valid, false otherwise

validate

void validate()
              throws Validator.InvalidValueException

Checks the validity of the validatable. If the validatable is valid this method should do nothing, and if it's not valid, it should throw Validator.InvalidValueException

Throws:
Validator.InvalidValueException - if the value is not valid

isInvalidAllowed

boolean isInvalidAllowed()

Checks the validabtable object accept invalid values.The default value is true.


setInvalidAllowed

void setInvalidAllowed(boolean invalidValueAllowed)
                       throws java.lang.UnsupportedOperationException

Should the validabtable object accept invalid values. Supporting this configuration possibility is optional. By default invalid values are allowed.

Parameters:
invalidValueAllowed -
Throws:
java.lang.UnsupportedOperationException - if the setInvalidAllowed is not supported.


Copyright © 2000-2011 Vaadin Ltd. All Rights Reserved.