org.josef.web.jsf.converter

Class ZipCodeConverter

java.lang.Object

org.josef.web.jsf.AbstractStateHolder

org.josef.web.jsf.converter.ZipCodeConverter

All Implemented Interfaces:

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

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

ZipCode Converter.
Usage: <jf:zipcodeConverter country="ISO3166Country"/>
Converting a zip code is all about applying the correct mask. This mask is fetched from ZipCodeOfCountry.

Version:

1.0 $Revision: 5812 $

Author:

Kees Schotanus

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ZipCodeConverter()

Method Summary

Modifier and Type	Method and Description
Object	getAsObject(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, String zipCode) Adds mask characters to the supplied zipCode.
String	getAsString(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, Object zipCode) Removes mask characters from the supplied zipCode.
Iso3166Country	getCountry() Gets the country of this ZipCodeConverter.
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	setCountry(Iso3166Country country) Sets the country for this ZipCodeConverter.

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

ZipCodeConverter

public ZipCodeConverter()

Method Detail

getCountry

public Iso3166Country getCountry()

Gets the country of this ZipCodeConverter.

Returns:

The country of this ZipCodeConverter.

setCountry

public void setCountry(Iso3166Country country)

Sets the country for this ZipCodeConverter.

Parameters:

country - The country for this ZipCodeConverter.

getAsObject

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

Adds mask characters to the supplied zipCode.

Specified by:

getAsObject in interface javax.faces.convert.Converter

Parameters:

facesContext - Faces Context.

component - The UI component that stores the zip code.

zipCode - The zip code to add the mask characters to.

Returns:

The supplied zipCode with the appropriate mask characters.

See Also:

SpecialMaskConverter.getAsObject(FacesContext, UIComponent, String)

getAsString

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

Removes mask characters from the supplied zipCode.

Specified by:

getAsString in interface javax.faces.convert.Converter

Parameters:

facesContext - Faces Context.

component - The UI component that stores the zip code.

zipCode - The zip code to remove the mask characters from.

Returns:

The supplied zipCode without the mask characters.

See Also:

GenericMaskConverter.getAsString(FacesContext, UIComponent, Object)

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