org.josef.web.jsf.validator

Class AbstractValidator

java.lang.Object

org.josef.web.jsf.AbstractStateHolder

org.josef.web.jsf.validator.AbstractValidator

All Implemented Interfaces:

EventListener, javax.faces.component.StateHolder, javax.faces.validator.Validator

Direct Known Subclasses:

BankIdentifierCodeValidator, BurgerServiceNummerValidator, DateRangeValidator, DutchBankGiroAccountNumberValidator, DutchGiroAccountNumberValidator, EmailValidator, InternationalBankAccountNumberValidator, ModuloElevenValidator, PatternValidator, RelationalValidator, ZipCodeValidator

public abstract class AbstractValidator
extends AbstractStateHolder
implements javax.faces.validator.Validator

Abstract superclass for all Validators.
This class supports the optional "message" attribute. When the message attribute is present on the validator's tag, then this message will be used instead of the standard error message provided by the specific validator.

Version:

1.0 $Revision: 6483 $

Author:

Kees Schotanus

Field Summary

Fields inherited from interface javax.faces.validator.Validator

NOT_IN_RANGE_MESSAGE_ID

Constructor Summary

Constructors

Constructor and Description
AbstractValidator()

Method Summary

Modifier and Type	Method and Description
javax.faces.application.FacesMessage	getFormattedErrorMessage(Object... messageArguments) Gets the formatted error message by substituting the supplied messageArguments into the message defined by the "message" attribute.
String	getMessage() Gets the message.
boolean	hasMessage() Determines whether this Validator has a message or not.
boolean	isComponentOfTypeUIInput(javax.faces.component.UIComponent component) Checks that the supplied uiComponent is of type UIInput.
void	restoreState(javax.faces.context.FacesContext facesContext, Object state) Restores the state saved by saveState(FacesContext).
Object	saveState(javax.faces.context.FacesContext facesContext) Saves the state of this validator.
void	setMessage(String message) Sets the message.

Methods inherited from class org.josef.web.jsf.AbstractStateHolder

isTransient, setTransient

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.validator.Validator

validate

Constructor Detail

AbstractValidator

public AbstractValidator()

Method Detail

getMessage

public String getMessage()

Gets the message.

Returns:

The message or null when no message attribute has been specified.

setMessage

public void setMessage(String message)

Sets the message.

Parameters:

message - The message to show in case of a validation error.

hasMessage

public boolean hasMessage()

Determines whether this Validator has a message or not.

Returns:

True when this Validator has a message, otherwise false is returned.

getFormattedErrorMessage

public javax.faces.application.FacesMessage getFormattedErrorMessage(Object... messageArguments)

Gets the formatted error message by substituting the supplied messageArguments into the message defined by the "message" attribute.
The message should contain place holders like "{0}", in order for this to succeed.

Parameters:

messageArguments - The message arguments to substitute into the supplied message.

Returns:

The formatted error message.

See Also:

Formatter.format(java.util.Locale, String, Object...)

isComponentOfTypeUIInput

public boolean isComponentOfTypeUIInput(javax.faces.component.UIComponent component)

Checks that the supplied uiComponent is of type UIInput.

Parameters:

component - The component to check.

Returns:

True when the supplied component is of type UIInput, otherwise false is returned and a sever error message is logged.

saveState

public Object saveState(javax.faces.context.FacesContext facesContext)

Saves the state of this validator.

Specified by:

saveState in interface javax.faces.component.StateHolder

Parameters:

facesContext - The FacesContext.

Returns:

The saved state of this validator.

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         Object state)

Restores the state saved by saveState(FacesContext).

Specified by:

restoreState in interface javax.faces.component.StateHolder

Parameters:

facesContext - The FacesContext.

state - The state saved by saveState(FacesContext).