io.guise.framework.validator.AbstractValidator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of guise-framework Show documentation
Show all versions of guise-framework Show documentation
Guise™ Internet application framework.
/*
* Copyright © 2005-2008 GlobalMentor, Inc. The value type this validator supports.
* @author Garret Wilson
*/
public abstract class AbstractValidator extends GuiseBoundPropertyObject implements Validator {
/** Whether the value must be non-null in order to be considered valid. */
private boolean valueRequired;
/** @return Whether the value must be non-null in order to be considered valid. */
public boolean isValueRequired() {
return valueRequired;
}
/**
* Sets whether the value must be non-null in order to be considered valid. This is a bound property of type Boolean.
* @param newValueRequired true if the value must be non-null in order to be considered valid.
* @see #VALUE_REQUIRED_PROPERTY
*/
public void setValueRequired(final boolean newValueRequired) {
if(valueRequired != newValueRequired) { //if the value is really changing
final boolean oldValueRequired = valueRequired; //get the current value
valueRequired = newValueRequired; //update the value
firePropertyChange(VALUE_REQUIRED_PROPERTY, Boolean.valueOf(oldValueRequired), Boolean.valueOf(newValueRequired));
}
}
/** The invalid value message text, which may include a resource reference. */
private String invalidValueMessage = VALIDATOR_INVALID_VALUE_MESSAGE_RESOURCE_REFERENCE;
@Override
public String getInvalidValueMessage() {
return invalidValueMessage;
}
@Override
public void setInvalidValueMessage(final String newInvalidValueMessage) {
if(!invalidValueMessage.equals(requireNonNull(newInvalidValueMessage, "Invalid value message cannot be null."))) { //if the value is really changing
final String oldInvalidValueMessage = invalidValueMessage; //get the old value
invalidValueMessage = newInvalidValueMessage; //actually change the value
firePropertyChange(INVALID_VALUE_MESSAGE_PROPERTY, oldInvalidValueMessage, newInvalidValueMessage); //indicate that the value changed
}
}
/** The value required message text, which may include a resource reference. */
private String valueRequiredMessage = VALIDATOR_VALUE_REQUIRED_MESSAGE_RESOURCE_REFERENCE;
@Override
public String getValueRequiredMessage() {
return valueRequiredMessage;
}
@Override
public void setValueRequiredMessage(final String newValueRequiredMessage) {
if(!valueRequiredMessage.equals(requireNonNull(newValueRequiredMessage, "Value required message cannot be null."))) { //if the value is really changing
final String oldValueRequiredMessage = valueRequiredMessage; //get the old value
valueRequiredMessage = newValueRequiredMessage; //actually change the value
firePropertyChange(VALUE_REQUIRED_MESSAGE_PROPERTY, oldValueRequiredMessage, newValueRequiredMessage); //indicate that the value changed
}
}
/**
* Throws a validation exception with a message indicating that the given value is invalid.
* @param value The value being validated.
* @throws ValidationException to indicate that the given value is invalid.
* @see #getInvalidValueMessage()
*/
public void throwInvalidValueValidationException(final V value) throws ValidationException {
final String invalidValueMessage = getSession().dereferenceString(getInvalidValueMessage()); //get the invalid value message to use
throw new ValidationException(format(invalidValueMessage, toString(value)), value); //format the message based upon the value
}
/**
* Throws a validation exception with a message indicating that a valid is required.
* @param value The value being validated.
* @throws ValidationException to indicate that a value is required.
* @see #getValueRequiredMessage()
*/
public void throwValueRequiredValidationException(final V value) throws ValidationException {
final String valueRequiredMessage = getSession().dereferenceString(getValueRequiredMessage()); //get the value required message to use
throw new ValidationException(valueRequiredMessage, value);
}
/** Default constructor with no value required. */
public AbstractValidator() {
this(false); //construct the class and don't required non-null values
}
/**
* Value required constructor.
* @param valueRequired Whether the value must be non-null in order to be considered valid.
*/
public AbstractValidator(final boolean valueRequired) {
this.valueRequired = valueRequired; //save the value required specification
}
/**
* {@inheritDoc}
*
* This version checks whether a value is provided if values are required. Child classes should call this version as a convenience for checking non-
* null and required status.
*
*
* Adding new validation logic always requires overriding this method. Although {@link #isValid(Object)} may be overridden to provide optimized fast-fail
* determinations, adding new logic to {@link #isValid(Object)} cannot be used in place of overriding this method.
*
* @see #throwInvalidValueValidationException(Object)
* @see #throwValueRequiredValidationException(Object)
*/
@Override
public void validate(final V value) throws ValidationException {
if(value == null && isValueRequired()) { //if there is no value but a value is required
throwValueRequiredValidationException(value); //indicate that a value is required
}
}
/**
* {@inheritDoc}
*
* This convenience version calls {@link #validate(Object)}, returning false only if an exception is thrown. Although this method may be
* overridden to provide optimized fast-fail determinations, adding new logic to this method cannot be used in place of overriding {@link #validate(Object)}.
*
*/
@Override
public boolean isValid(final V value) {
try {
validate(value); //validate the value
return true; //indicate that the value validated
} catch(final ValidationException validationException) { //if the value didn't validate
return false; //indicate that the value is not valid
}
}
/**
* Retrieves a string representation of the given value appropriate for error messages. This implementation returns the {@link Object#toString()} string
* representation of the value.
* @param value The value for which a string representation should be returned.
* @return A string representation of the given value.
*/
protected String toString(final V value) {
return value.toString(); //return to toString() version by default
}
}