javax.faces.validator.LongRangeValidator Maven / Gradle / Ivy
/*
* $Id: LongRangeValidator.java,v 1.45 2007/01/29 07:13:41 rlubke Exp $
*/
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* https://javaserverfaces.dev.java.net/CDDL.html or
* legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* [Name of File] [ver.__] [Date]
*
* Copyright 2005 Sun Microsystems Inc. All Rights Reserved
*/
package javax.faces.validator;
import javax.faces.component.StateHolder;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.convert.Converter;
/**
* LongRangeValidator is a {@link Validator} that checks
* the value of the corresponding component against specified minimum and
* maximum values. The following algorithm is implemented:
*
* - If the passed value is
null, exit immediately.
* - If the current component value is not a floating point type, or
* a String that is convertible to long,
* throw a {@link ValidatorException} containing a
* TYPE_MESSAGE_ID message.
* - If both a
maximum and minimum property
* has been configured on this {@link Validator}, check the component
* value against both limits. If the component value is not within
* this specified range, throw a {@link ValidatorException} containing a
* {@link #NOT_IN_RANGE_MESSAGE_ID} message.
* - If a
maximum property has been configured on this
* {@link Validator}, check the component value against
* this limit. If the component value is greater than the
* specified maximum, throw a {@link ValidatorException} containing a
* MAXIMUM_MESSAGE_ID message.
* - If a
minimum property has been configured on this
* {@link Validator}, check the component value against
* this limit. If the component value is less than the
* specified minimum, throw a {@link ValidatorException} containing a
* MINIMUM_MESSAGE_ID message.
*
*
* For all of the above cases that cause a {@link 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 {@link Converter} registered in the application
* under the converter id javax.faces.Number. This allows
* the values to be localized according to the current
* Locale.
*/
public class LongRangeValidator implements Validator, StateHolder {
// ------------------------------------------------------ Manifest Constants
/**
* The standard converter id for this converter.
*/
public static final String VALIDATOR_ID = "javax.faces.LongRange";
/**
* The message identifier of the {@link javax.faces.application.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 String MAXIMUM_MESSAGE_ID =
"javax.faces.validator.LongRangeValidator.MAXIMUM";
/**
* The message identifier of the {@link javax.faces.application.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 String MINIMUM_MESSAGE_ID =
"javax.faces.validator.LongRangeValidator.MINIMUM";
/**
* The message identifier of the {@link javax.faces.application.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 String NOT_IN_RANGE_MESSAGE_ID =
"javax.faces.validator.LongRangeValidator.NOT_IN_RANGE";
/**
* The message identifier of the {@link javax.faces.application.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.
*/
public static final String TYPE_MESSAGE_ID =
"javax.faces.validator.LongRangeValidator.TYPE";
// ------------------------------------------------------------ Constructors
/**
* Construct a {@link Validator} with no preconfigured limits.
*/
public LongRangeValidator() {
super();
}
/**
* Construct a {@link Validator} with the specified preconfigured
* limit.
*
* @param maximum Maximum value to allow
*/
public LongRangeValidator(long maximum) {
super();
setMaximum(maximum);
}
/**
* Construct a {@link Validator} with the specified preconfigured
* limits.
*
* @param maximum Maximum value to allow
* @param minimum Minimum value to allow
*/
public LongRangeValidator(long maximum, long minimum) {
super();
setMaximum(maximum);
setMinimum(minimum);
}
// -------------------------------------------------------------- Properties
private long maximum = 0;
private boolean maximumSet = false;
/**
* Return the maximum value to be enforced by this {@link Validator}.
*/
public long getMaximum() {
return (this.maximum);
}
/**
* Set the maximum value to be enforced by this {@link Validator}.
*
* @param maximum The new maximum value
*/
public void setMaximum(long maximum) {
this.maximum = maximum;
this.maximumSet = true;
}
private long minimum = 0;
private boolean minimumSet = false;
/**
* Return the minimum value to be enforced by this {@link Validator}.
*/
public long getMinimum() {
return (this.minimum);
}
/**
* Set the minimum value to be enforced by this {@link Validator}.
*
* @param minimum The new minimum value
*/
public void setMinimum(long minimum) {
this.minimum = minimum;
this.minimumSet = true;
}
// ------------------------------------------------------- Validator Methods
/**
* @throws NullPointerException {@inheritDoc}
* @throws ValidatorException {@inheritDoc}
*/
public void validate(FacesContext context,
UIComponent component,
Object value) throws ValidatorException {
if ((context == null) || (component == null)) {
throw new NullPointerException();
}
if (value != null) {
try {
long converted = longValue(value);
if (maximumSet &&
(converted > maximum)) {
if (minimumSet) {
throw new ValidatorException(MessageFactory.getMessage
(context,
NOT_IN_RANGE_MESSAGE_ID,
stringValue(component,
new Long(minimum), context),
stringValue(component,
new Long(maximum), context),
MessageFactory.getLabel(context, component)));
} else {
throw new ValidatorException(MessageFactory.getMessage
(context,
MAXIMUM_MESSAGE_ID,
stringValue(component,
new Long(maximum), context),
MessageFactory.getLabel(context, component)));
}
}
if (minimumSet &&
(converted < minimum)) {
if (maximumSet) {
throw new ValidatorException(MessageFactory.getMessage
(context,
NOT_IN_RANGE_MESSAGE_ID,
stringValue(component,
new Long(minimum), context),
stringValue(component,
new Long(maximum), context),
MessageFactory.getLabel(context, component)));
} else {
throw new ValidatorException(MessageFactory.getMessage
(context,
MINIMUM_MESSAGE_ID,
stringValue(component,
new Long(minimum), context),
MessageFactory.getLabel(context, component)));
}
}
} catch (NumberFormatException e) {
throw new ValidatorException(MessageFactory.getMessage
(context, TYPE_MESSAGE_ID,
MessageFactory.getLabel(context, component)));
}
}
}
public boolean equals(Object otherObj) {
if (!(otherObj instanceof LongRangeValidator)) {
return false;
}
LongRangeValidator other = (LongRangeValidator) otherObj;
return ((maximum == other.maximum) &&
(minimum == other.minimum) &&
(maximumSet == other.maximumSet) &&
(minimumSet == other.minimumSet));
}
public int hashCode() {
int hashCode = new Long(minimum).hashCode()
+ new Long(maximum).hashCode()
+ Boolean.valueOf(minimumSet).hashCode()
+ Boolean.valueOf(maximumSet).hashCode();
return (hashCode);
}
// --------------------------------------------------------- Private Methods
/**
* Return the specified attribute value, converted to a
* long.
*
* @param attributeValue The attribute value to be converted
* @throws NumberFormatException if conversion is not possible
*/
private static long longValue(Object attributeValue)
throws NumberFormatException {
if (attributeValue instanceof Number) {
return (((Number) attributeValue).longValue());
} else {
return (Long.parseLong(attributeValue.toString()));
}
}
private static String stringValue(UIComponent component,
Long toConvert,
FacesContext context) {
Converter converter =
context.getApplication().createConverter("javax.faces.Number");
String result = converter.getAsString(context, component, toConvert);
return result;
}
// ----------------------------------------------------- StateHolder Methods
public Object saveState(FacesContext context) {
Object values[] = new Object[4];
values[0] = new Long(maximum);
values[1] = maximumSet ? Boolean.TRUE : Boolean.FALSE;
values[2] = new Long(minimum);
values[3] = minimumSet ? Boolean.TRUE : Boolean.FALSE;
return (values);
}
public void restoreState(FacesContext context, Object state) {
Object values[] = (Object[]) state;
maximum = ((Long) values[0]).longValue();
maximumSet = ((Boolean) values[1]).booleanValue();
minimum = ((Long) values[2]).longValue();
minimumSet = ((Boolean) values[3]).booleanValue();
}
private boolean transientValue = false;
public boolean isTransient() {
return (this.transientValue);
}
public void setTransient(boolean transientValue) {
this.transientValue = transientValue;
}
}