org.apache.shale.clay.convert
Class StringArrayConverter

java.lang.Object
  extended by org.apache.shale.clay.convert.StringArrayConverter
All Implemented Interfaces:
javax.faces.convert.Converter

public class StringArrayConverter
extends Object
implements javax.faces.convert.Converter

Converts a String to a String[] or vise versa. This converter is targeted at supporting the myfaces trinidad partialTriggers component properties. The default element delimiter is none and the default element separator is a space.


Constructor Summary
StringArrayConverter()
           
 
Method Summary
 Object getAsObject(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, String value)
          Converts the value into a string array using the element delimiter and element separator.
 String getAsString(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, Object value)
          Converts a string array into a value delimited string.
 Character getDelimiter()
           
 Character getSeparator()
           
 void setDelimiter(Character delimiter)
           
 void setSeparator(Character separator)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StringArrayConverter

public StringArrayConverter()
Method Detail

getDelimiter

public Character getDelimiter()
Returns:
the element begining and ending delimiter

setDelimiter

public void setDelimiter(Character delimiter)
Parameters:
delimiter - element begining and ending delimiter char

getSeparator

public Character getSeparator()
Returns:
the character used to delimit elements

setSeparator

public void setSeparator(Character separator)
Parameters:
separator - the character used to delimit elements

getAsObject

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

Converts the value into a string array using the element delimiter and element separator.

Specified by:
getAsObject in interface javax.faces.convert.Converter
Parameters:
facesContext - faces context
component - value holder component
value - source value to converter to a String[]
Returns:
the target type is a String[]

getAsString

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

Converts a string array into a value delimited string. The delimiter and separator properties are used to distinguish each element.

Specified by:
getAsString in interface javax.faces.convert.Converter
Parameters:
facesContext - faces context
component - value owning component
value - source String array that is converter into a tokenized String
Returns:
delimited string holding all values of the source string array


Copyright © 2004-2007 Apache Software Foundation. All Rights Reserved.