|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.faces.validator.DoubleRangeValidator
public class DoubleRangeValidator
DoubleRangeValidator is a Validator that checks
the value of the corresponding component against specified minimum and
maximum values. The following algorithm is implemented:
null, exit immediately.ValidatorException containing a
TYPE_MESSAGE_ID message.maximum and minimum property
has been configured on this Validator, check the component
value against both limits. If the component value is not within
this specified range, throw a ValidatorException containing a
NOT_IN_RANGE_MESSAGE_ID message.maximum property has been configured on this
Validator, check the component value against
this limit. If the component value is greater than the
specified maximum, throw a ValidatorException containing a
MAXIMUM_MESSAGE_ID message.minimum property has been configured on this
Validator, check the component value against
this limit. If the component value is less than the
specified minimum, throw a ValidatorException containing a
MINIMUM_MESSAGE_ID message.For all of the above cases that cause a ValidatorException
to be thrown, if there are parameters to the message that match up
with validator parameters, the values of these parameters must be
converted using the Converter registered in the application
under the converter id javax.faces.Number. This allows
the values to be localized according to the current
Locale.
| Field Summary | |
|---|---|
static java.lang.String |
MAXIMUM_MESSAGE_ID
The message identifier of the FacesMessage
to be created if the maximum value check fails. |
static java.lang.String |
MINIMUM_MESSAGE_ID
The message identifier of the FacesMessage
to be created if the minimum value check fails. |
static java.lang.String |
NOT_IN_RANGE_MESSAGE_ID
The message identifier of the FacesMessage to be created if
the maximum or minimum value check fails, and both the maximum
and minimum values for this validator have been set. |
static java.lang.String |
TYPE_MESSAGE_ID
The message identifier of the FacesMessage
to be created if the current value of this component is not of the
correct type. |
static java.lang.String |
VALIDATOR_ID
The standard converter id for this converter. |
| Constructor Summary | |
|---|---|
DoubleRangeValidator()
Construct a Validator with no preconfigured limits. |
|
DoubleRangeValidator(double maximum)
Construct a Validator with the specified preconfigured
limit. |
|
DoubleRangeValidator(double maximum,
double minimum)
Construct a Validator with the specified preconfigured
limits. |
|
| Method Summary | |
|---|---|
void |
clearInitialState()
Reset the PartialStateHolder to a non-delta tracking state. |
boolean |
equals(java.lang.Object otherObj)
|
double |
getMaximum()
Return the maximum value to be enforced by this Validator or Double.MAX_VALUE if it has not been
set. |
double |
getMinimum()
Return the minimum value to be enforced by this Validator, or Double.MIN_VALUE if it has not been
set. |
int |
hashCode()
|
boolean |
initialStateMarked()
Return |
boolean |
isTransient()
If true, the Object implementing this interface must not participate in state saving or restoring. |
void |
markInitialState()
The runtime must ensure that the
|
void |
restoreState(FacesContext context,
java.lang.Object state)
Perform any processing required to restore the state from the entries in the state Object. |
java.lang.Object |
saveState(FacesContext context)
Gets the state of the instance as a Serializable Object. |
void |
setMaximum(double maximum)
Set the maximum value to be enforced by this Validator. |
void |
setMinimum(double minimum)
Set the minimum value to be enforced by this Validator. |
void |
setTransient(boolean transientValue)
Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring. |
void |
validate(FacesContext context,
UIComponent component,
java.lang.Object value)
Perform the correctness checks implemented by this Validator against
the specified UIComponent. |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String VALIDATOR_ID
The standard converter id for this converter.
public static final java.lang.String MAXIMUM_MESSAGE_ID
The message identifier of the FacesMessage
to be created if the maximum value check fails. The message format
string for this message may optionally include the following
placeholders:
{0} replaced by the configured maximum value.{1} replaced by a String whose value
is the label of the input component that produced this message.
public static final java.lang.String MINIMUM_MESSAGE_ID
The message identifier of the FacesMessage
to be created if the minimum value check fails. The message format
string for this message may optionally include the following
placeholders:
{0} replaced by the configured minimum value.{1} replaced by a String whose value
is the label of the input component that produced this message.
public static final java.lang.String NOT_IN_RANGE_MESSAGE_ID
The message identifier of the FacesMessage to be created if
the maximum or minimum value check fails, and both the maximum
and minimum values for this validator have been set. The message
format string for this message may optionally include the following
placeholders:
{0} replaced by the configured minimum value.{1} replaced by the configured maximum value.{2} replaced by a String whose value
is the label of the input component that produced this message.
public static final java.lang.String TYPE_MESSAGE_ID
The message identifier of the FacesMessage
to be created if the current value of this component is not of the
correct type. The message format string for this message may
optionally include a {0} placeholder that will be
replaced by a String whose value is the label of
the input component that produced this message.
| Constructor Detail |
|---|
public DoubleRangeValidator()
Construct a Validator with no preconfigured limits.
public DoubleRangeValidator(double maximum)
Construct a Validator with the specified preconfigured
limit.
maximum - Maximum value to allow
public DoubleRangeValidator(double maximum,
double minimum)
Construct a Validator with the specified preconfigured
limits.
maximum - Maximum value to allowminimum - Minimum value to allow| Method Detail |
|---|
public double getMaximum()
Return the maximum value to be enforced by this Validator or Double.MAX_VALUE if it has not been
set.
public void setMaximum(double maximum)
Set the maximum value to be enforced by this Validator.
maximum - The new maximum valuepublic double getMinimum()
Return the minimum value to be enforced by this Validator, or Double.MIN_VALUE if it has not been
set.
public void setMinimum(double minimum)
Set the minimum value to be enforced by this Validator.
minimum - The new minimum value
public void validate(FacesContext context,
UIComponent component,
java.lang.Object value)
throws ValidatorException
ValidatorPerform the
correctness checks implemented by this Validator against
the specified UIComponent. If any violations are found,
a ValidatorException will be thrown containing the FacesMessage describing the failure.
For a validator to be fully compliant with Version 2 and later
of the specification, it must not fail validation on
null or empty values unless it is specifically
intended to address null or empty values. An
application-wide <context-param> is provided
to allow validators designed for JSF 1.2 to work with JSF 2 and
later. The javax.faces.VALIDATE_EMPTY_FIELDS
<context-param> must be set to
false to enable this backwards compatibility
behavior.
validate in interface Validatorcontext - FacesContext for the request we are processingcomponent - UIComponent we are checking for correctnessvalue - the value to validate
java.lang.NullPointerException - if context
or component is null
ValidatorException - if validation failspublic boolean equals(java.lang.Object otherObj)
equals in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Objectpublic java.lang.Object saveState(FacesContext context)
StateHolder Gets the state of the instance as a
Serializable Object.
If the class that implements this interface has references to
instances that implement StateHolder (such as a
UIComponent with event handlers, validators, etc.)
this method must call the StateHolder.saveState(javax.faces.context.FacesContext) method on all those
instances as well. This method must not save the state
of children and facets. That is done via the StateManager
This method must not alter the state of the implementing object. In other words, after executing this code:
Object state = component.saveState(facesContext);
component should be the same as before executing
it.
The return from this method must be Serializable
saveState in interface StateHolder
public void restoreState(FacesContext context,
java.lang.Object state)
StateHolderPerform any processing required to restore the state from the entries in the state Object.
If the class that implements this interface has references to
instances that also implement StateHolder (such as a
UIComponent with event handlers, validators, etc.)
this method must call the StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object) method on all those
instances as well.
restoreState in interface StateHolderpublic boolean isTransient()
StateHolderIf true, the Object implementing this interface must not participate in state saving or restoring.
isTransient in interface StateHolderpublic void setTransient(boolean transientValue)
StateHolderDenotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.
setTransient in interface StateHoldertransientValue - boolean pass true if this Object
will participate in state saving or restoring, otherwise
pass false.public void markInitialState()
PartialStateHolderThe runtime must ensure that the
PartialStateHolder.markInitialState() method is called on each instance of
this interface in the view at the appropriate time to indicate
the component is in its initial state. The implementor of the
interface must ensure that PartialStateHolder.initialStateMarked() returns
true from the time markInitialState()
is called until PartialStateHolder.clearInitialState() is called, after which
time initialStateMarked() must return
false. Also, during the time that the instance
returns true from initialStateMarked(),
the implementation must return only the state that has changed in
its implementation of StateHolder#saveState.
markInitialState in interface PartialStateHolderpublic boolean initialStateMarked()
PartialStateHolderReturn true if delta
state changes are being tracked, otherwise false
initialStateMarked in interface PartialStateHolderpublic void clearInitialState()
PartialStateHolderReset the PartialStateHolder to a non-delta tracking state.
clearInitialState in interface PartialStateHolder
|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright © 2009 Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.
Generated on 24-November-2009 03:24