org.apache.myfaces.validator
Class ValidatorBase

java.lang.Object
  org.apache.myfaces.validator.ValidatorBase

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractCreditCardValidator, AbstractEqualValidator, AbstractRegExprValidator, EmailValidator

@JSFValidator(configExcluded=true,
              tagClass="org.apache.myfaces.validator.ValidatorBaseTag",
              tagHandler="org.apache.myfaces.validator.ValidatorBaseTagHandler")
public abstract class ValidatorBase
extends java.lang.Object
implements javax.faces.component.StateHolder, javax.faces.validator.Validator

Base validator implementation for Apache MyFaces Commons Validators.

Field Summary

Fields inherited from interface javax.faces.validator.Validator

NOT_IN_RANGE_MESSAGE_ID

Constructor Summary

ValidatorBase()

Method Summary

java.lang.String	getDetailMessage()
protected javax.faces.context.FacesContext	getFacesContext()
protected javax.faces.application.FacesMessage	getFacesMessage(java.lang.String defaultMessage, java.lang.Object[] args)
java.lang.String	getMessage() Deprecated. Use getDetailMessage()
protected java.lang.String	getStringValue(javax.faces.context.FacesContext context, javax.el.ValueExpression vb)
java.lang.String	getSummaryMessage()
javax.el.ValueExpression	getValueExpression(java.lang.String name)
boolean	isTransient()
static java.lang.Object	restoreAttachedState(javax.faces.context.FacesContext context, java.lang.Object stateObj)
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
static java.lang.Object	saveAttachedState(javax.faces.context.FacesContext context, java.lang.Object attachedObject) Serializes objects which are "attached" to this component but which are not UIComponent children of it.
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setDetailMessage(java.lang.String message)
void	setMessage(java.lang.String message) Deprecated. Use setDetailMessage()
void	setSummaryMessage(java.lang.String message)
void	setTransient(boolean newTransientValue)
void	setValueExpression(java.lang.String name, javax.el.ValueExpression binding)

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

ValidatorBase

public ValidatorBase()

Method Detail

getSummaryMessage

@JSFProperty
public java.lang.String getSummaryMessage()

Returns:

The summary message to be displayed

setSummaryMessage

public void setSummaryMessage(java.lang.String message)

Parameters:

message - The summary message to be displayed.

getMessage

@JSFProperty
public java.lang.String getMessage()

Deprecated. Use getDetailMessage()

Returns:

The message.

setMessage

public void setMessage(java.lang.String message)

Deprecated. Use setDetailMessage()

Parameters:

message - The detail message to be displayed.

getDetailMessage

@JSFProperty
public java.lang.String getDetailMessage()

Returns:

The detail message.

setDetailMessage

public void setDetailMessage(java.lang.String message)

Parameters:

message - The detail message to be displayed.

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Parameters:

context -

restoreState

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

Specified by:

restoreState in interface javax.faces.component.StateHolder

isTransient

public boolean isTransient()

Specified by:

isTransient in interface javax.faces.component.StateHolder

setTransient

public void setTransient(boolean newTransientValue)

Specified by:

setTransient in interface javax.faces.component.StateHolder

getFacesMessage

protected javax.faces.application.FacesMessage getFacesMessage(java.lang.String defaultMessage,
                                                               java.lang.Object[] args)

Parameters:

defaultMessage - The default message we would expect.

args - Arguments for parsing this message.

Returns:

FacesMessage

getValueExpression

public javax.el.ValueExpression getValueExpression(java.lang.String name)

setValueExpression

public void setValueExpression(java.lang.String name,
                               javax.el.ValueExpression binding)

saveAttachedState

public static java.lang.Object saveAttachedState(javax.faces.context.FacesContext context,
                                                 java.lang.Object attachedObject)

Serializes objects which are "attached" to this component but which are not UIComponent children of it. Examples are validator and listener objects. To be precise, it returns an object which implements java.io.Serializable, and which when serialized will persist the state of the provided object.

If the attachedObject is a List then every object in the list is saved via a call to this method, and the returned wrapper object contains a List object.

If the object implements StateHolder then the object's saveState is called immediately, and a wrapper is returned which contains both this saved state and the original class name. However in the case where the StateHolder.isTransient method returns true, null is returned instead.

If the object implements java.io.Serializable then the object is simply returned immediately; standard java serialization will later be used to store this object.

In all other cases, a wrapper is returned which simply stores the type of the provided object. When deserialized, a default instance of that type will be recreated.

restoreAttachedState

public static java.lang.Object restoreAttachedState(javax.faces.context.FacesContext context,
                                                    java.lang.Object stateObj)
                                             throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

getFacesContext

protected javax.faces.context.FacesContext getFacesContext()

getStringValue

protected java.lang.String getStringValue(javax.faces.context.FacesContext context,
                                          javax.el.ValueExpression vb)