org.josef.web.jsf.converter

Class GenericMaskConverter

java.lang.Object

org.josef.web.jsf.AbstractStateHolder

org.josef.web.jsf.converter.GenericMaskConverter

All Implemented Interfaces:

Serializable, javax.faces.component.StateHolder, javax.faces.convert.Converter

Direct Known Subclasses:

SpecialMaskConverter

public class GenericMaskConverter
extends AbstractStateHolder
implements javax.faces.convert.Converter, Serializable

Generic Mask Converter.
Uses a mask to convert to and from a String.
Usage: <jf:mask mask="mask" />
Multiple masks may be specified by using the pipe (|) symbol. When multiple masks are supplied, each one will be used in turn to mask/unmask. This class uses Mask to do the actual masking and unmasking.

Version:

1.0 $Revision: 5792 $

Author:

Kees Schotanus

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GenericMaskConverter()

Method Summary

Modifier and Type	Method and Description
Object	getAsObject(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, String maskedValue) Converts the supplied maskedValue to a String that does not contain any mask characters.
String	getAsString(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, Object unmaskedValue) Converts the supplied unmaskedValue to a masked value.
String	getMask() Gets the mask attribute.
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 converter.
void	setMask(String mask) Sets the mask attribute.

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

Constructor Detail

GenericMaskConverter

public GenericMaskConverter()

Method Detail

getMask

public String getMask()

Gets the mask attribute.

Returns:

The mask attribute or null when no mask attribute has been supplied.

setMask

public void setMask(String mask)

Sets the mask attribute.

Parameters:

mask - The mask attribute.

getAsObject

public Object getAsObject(javax.faces.context.FacesContext facesContext,
                          javax.faces.component.UIComponent component,
                          String maskedValue)

Converts the supplied maskedValue to a String that does not contain any mask characters.

Specified by:

getAsObject in interface javax.faces.convert.Converter

Parameters:

facesContext - Faces Context.

component - The UI component that stores the unmasked value.

maskedValue - The value to convert.

Returns:

The converted unmasked value. When the supplied maskedValue is null or empty, or when no mask has been supplied, the supplied maskedValue is returned as-is.

Throws:

javax.faces.convert.ConverterException - When the supplied maskedValue does not correspond to the mask.

getAsString

public String getAsString(javax.faces.context.FacesContext facesContext,
                          javax.faces.component.UIComponent component,
                          Object unmaskedValue)

Converts the supplied unmaskedValue to a masked value.

Specified by:

getAsString in interface javax.faces.convert.Converter

Parameters:

facesContext - Faces Context.

component - The UI component that stores the unmasked value.

unmaskedValue - The unmasked value to convert to a masked value.

Returns:

The masked value of the supplied non masked value.
Null is returned when the supplied unmaskedValue is not of type String. When a conversion error occurs, the supplied unmaskedValue is returned as a String.

Throws:

javax.faces.convert.ConverterException - When the supplied unmaskedValue does not correspond to the mask.

saveState

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

Saves the state of this converter.

Specified by:

saveState in interface javax.faces.component.StateHolder

Parameters:

facesContext - The FacesContext.

Returns:

The saved state of this converter.

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).