org.josef.web.jsf.converter

Class GenericStringConverter

java.lang.Object

org.josef.web.jsf.AbstractStateHolder

org.josef.web.jsf.converter.GenericStringConverter

All Implemented Interfaces:

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

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

Generic String Converter.
Performs String manipulation, like converting to upper case for example. Usage:
<jf:genericStringConverter [trim="LEFT|RIGHT|BOTH|ALL"] [case="UPPER|LOWER"]/>
Since the attributes are backed by enumerated types the attribute values really need to be in upper case.

Version:

1.0 $Revision: 5792 $

Author:

Kees Schotanus

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GenericStringConverter()

Method Summary

Modifier and Type	Method and Description
Object	getAsObject(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, String value) Converts the supplied String value to a new String.
String	getAsString(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, Object value) Converts the supplied value to a String, by calling toString() on it.
Case	getCase() Gets the case attribute.
Trim	getTrim() Gets the trim 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	setCase(Case theCase) Sets the case attribute.
void	setTrim(Trim trim) Sets the trim 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

GenericStringConverter

public GenericStringConverter()

Method Detail

getTrim

public Trim getTrim()

Gets the trim attribute.

Returns:

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

setTrim

public void setTrim(Trim trim)

Sets the trim attribute.

Parameters:

trim - The trim attribute.

getCase

public Case getCase()

Gets the case attribute.

Returns:

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

setCase

public void setCase(Case theCase)

Sets the case attribute.

Parameters:

theCase - The case attribute.

getAsObject

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

Converts the supplied String value to a new String.

Specified by:

getAsObject in interface javax.faces.convert.Converter

Parameters:

facesContext - Faces Context.

component - The UI component that stores the String value.

value - The value to convert.

Returns:

The converted value.

getAsString

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

Converts the supplied value to a String, by calling toString() on it.

Specified by:

getAsString in interface javax.faces.convert.Converter

Parameters:

facesContext - Faces Context.

component - The UI component that stores the String value.

value - The value to convert to a String.

Returns:

The converted String value of the supplied value.
Null is returned when either the supplied value is null or when the supplied value is not of type String.

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