| org.apache.turbine.util.parser.ValueParser
All known Subclasses: org.apache.turbine.util.parser.BaseValueParser,
| ValueParser | | public interface ValueParser (Code) | | ValueParser is a base interface for classes that need to parse
name/value Parameters, for example GET/POST data or Cookies
(ParameterParser and CookieParser)
NOTE: The name= portion of a name=value pair may be converted
to lowercase or uppercase when the object is initialized and when
new data is added. This behaviour is determined by the url.case.folding
property in TurbineResources.properties. Adding a name/value pair may
overwrite existing name=value pairs if the names match:
author:
Ilkka Priha
author:
Jon S. Stevens
author:
Sean Legassick
author:
Jason van Zyl
author:
Henning P. Schmiedehausen
author:
Quinton McCombs
version:
$Id: ValueParser.java 534527 2007-05-02 16:10:59Z tv $ |
| Method Summary | |
| void | add(String name, double value)
Add a name/value pair into this object. | | void | add(String name, int value)
Add a name/value pair into this object. | | void | add(String name, Integer value)
Add a name/value pair into this object. | | void | add(String name, long value)
Add a name/value pair into this object. | | void | add(String name, String value)
Add a name/value pair into this object. | | void | add(String name, String[] value)
Add an array of Strings for a key. | | void | append(String name, String value)
Add a String parameter. | | void | clear()
Clear all name/value pairs out of this object. | | boolean | containsDateSelectorKeys(String key)
Check for existence of key_day, key_month and key_year
parameters (as returned by DateSelector generated HTML).
Parameters:
key - A String with the selector name. | | boolean | containsKey(Object key)
Determine whether a given key has been inserted. | | String | convert(String value)
Trims the string data and applies the conversion specified in
the property given by URL_CASE_FOLDING. | | String | get(String name)
Return a String for the given name. | | BigDecimal | getBigDecimal(String name, BigDecimal defaultValue)
Return a BigDecimal for the given name. | | BigDecimal | getBigDecimal(String name)
Return a BigDecimal for the given name. | | BigDecimal[] | getBigDecimals(String name)
Return an array of BigDecimals for the given name. | | Boolean | getBool(String name, boolean defaultValue)
Return a Boolean for the given name. | | Boolean | getBool(String name)
Return a Boolean for the given name. | | boolean | getBoolean(String name, boolean defaultValue)
Return a boolean for the given name. | | boolean | getBoolean(String name)
Return a boolean for the given name. | | Boolean | getBooleanObject(String name)
Returns a Boolean object for the given name. | | Boolean | getBooleanObject(String name, Boolean defaultValue)
Returns a Boolean object for the given name. | | byte | getByte(String name, byte defaultValue)
Return a byte for the given name. | | byte | getByte(String name)
Return a byte for the given name. | | Byte | getByteObject(String name, Byte defaultValue)
Return a byte for the given name. | | Byte | getByteObject(String name)
Return a byte for the given name. | | byte[] | getBytes(String name)
Return an array of bytes for the given name. | | String | getCharacterEncoding()
Get the character encoding that will be used by this ValueParser. | | Date | getDate(String name, DateFormat df, Date defaultValue)
Returns a java.util.Date object. | | Date | getDate(String name)
Returns a java.util.Date object. | | Date | getDate(String name, DateFormat df)
Returns a java.util.Date object. | | double | getDouble(String name, double defaultValue)
Return a double for the given name. | | double | getDouble(String name)
Return a double for the given name. | | Double | getDoubleObject(String name, Double defaultValue)
Return a Double for the given name. | | Double | getDoubleObject(String name)
Return a Double for the given name. | | Double[] | getDoubleObjects(String name)
Return an array of doubles for the given name. | | double[] | getDoubles(String name)
Return an array of doubles for the given name. | | float | getFloat(String name, float defaultValue)
Return a float for the given name. | | float | getFloat(String name)
Return a float for the given name. | | Float | getFloatObject(String name, Float defaultValue)
Return a Float for the given name. | | Float | getFloatObject(String name)
Return a float for the given name. | | Float[] | getFloatObjects(String name)
Return an array of floats for the given name. | | float[] | getFloats(String name)
Return an array of floats for the given name. | | int | getInt(String name, int defaultValue)
Return an int for the given name. | | int | getInt(String name)
Return an int for the given name. | | Integer | getIntObject(String name, Integer defaultValue)
Return an Integer for the given name. | | Integer | getIntObject(String name)
Return an Integer for the given name. | | Integer[] | getIntObjects(String name)
Return an array of Integers for the given name. | | Integer | getInteger(String name, int defaultValue)
Return an Integer for the given name. | | Integer | getInteger(String name, Integer defaultValue)
Return an Integer for the given name. | | Integer | getInteger(String name)
Return an Integer for the given name. | | Integer[] | getIntegers(String name)
Return an array of Integers for the given name. | | int[] | getInts(String name)
Return an array of ints for the given name. | | Object[] | getKeys()
Returns all the available parameter names. | | long | getLong(String name, long defaultValue)
Return a long for the given name. | | long | getLong(String name)
Return a long for the given name. | | Long | getLongObject(String name, Long defaultValue)
Return a Long for the given name. | | Long | getLongObject(String name)
Return a Long for the given name. | | Long[] | getLongObjects(String name)
Return an array of Longs for the given name. | | long[] | getLongs(String name)
Return an array of longs for the given name. | | NumberKey | getNumberKey(String name)
Return an NumberKey for the given name. | | Object | getObject(String name)
Return an Object for the given name. | | Object[] | getObjects(String name)
Return an array of Objects for the given name. | | String | getString(String name)
Return a String for the given name. | | String | getString(String name, String defaultValue)
Return a String for the given name. | | StringKey | getStringKey(String name)
Return an NumberKey for the given name. | | String[] | getStrings(String name)
Return an array of Strings for the given name. | | String[] | getStrings(String name, String[] defaultValue)
Return an array of Strings for the given name. | | Set | keySet()
Gets the keys. | | Enumeration | keys()
Get an enumerator for the parameter keys. | | Object | remove(String name)
Removes the named parameter from the contained hashtable. | | void | setCharacterEncoding(String s)
Set the character encoding that will be used by this ValueParser. | | void | setProperties(Object bean)
Uses bean introspection to set writable properties of bean from
the parameters, where a (case-insensitive) name match between
the bean property and the parameter is looked for. | | void | setString(String name, String value)
Set a parameter to a specific value. | | void | setStrings(String name, String[] values)
Set a parameter to a specific value. | | String | toString()
Simple method that attempts to get a toString() representation
of this object. |
| URL_CASE_FOLDING | | String URL_CASE_FOLDING(Code) | | The Key for the Case folding.
|
| URL_CASE_FOLDING_LOWER | | String URL_CASE_FOLDING_LOWER(Code) | | Fold Keys to lower case.
|
| URL_CASE_FOLDING_NONE | | String URL_CASE_FOLDING_NONE(Code) | | No Case folding.
|
| URL_CASE_FOLDING_UPPER | | String URL_CASE_FOLDING_UPPER(Code) | | Fold Keys to upper case.
|
| add | | void add(String name, double value)(Code) | | Add a name/value pair into this object.
Parameters:
name - A String with the name.
Parameters:
value - A double with the value. |
| add | | void add(String name, int value)(Code) | | Add a name/value pair into this object.
Parameters:
name - A String with the name.
Parameters:
value - An int with the value. |
| add | | void add(String name, Integer value)(Code) | | Add a name/value pair into this object.
Parameters:
name - A String with the name.
Parameters:
value - An Integer with the value. |
| add | | void add(String name, long value)(Code) | | Add a name/value pair into this object.
Parameters:
name - A String with the name.
Parameters:
value - A long with the value. |
| add | | void add(String name, String value)(Code) | | Add a name/value pair into this object.
Parameters:
name - A String with the name.
Parameters:
value - A long with the value. |
| add | | void add(String name, String[] value)(Code) | | Add an array of Strings for a key. This
is simply adding all the elements in the
array one by one.
Parameters:
name - A String with the name.
Parameters:
value - A String Array. |
| append | | void append(String name, String value)(Code) | | Add a String parameter. If there are any Strings already
associated with the name, append to the array. This is used
for handling parameters from mulitipart POST requests.
Parameters:
name - A String with the name.
Parameters:
value - A String with the value. |
| clear | | void clear()(Code) | | Clear all name/value pairs out of this object.
|
| containsDateSelectorKeys | | boolean containsDateSelectorKeys(String key)(Code) | | Check for existence of key_day, key_month and key_year
parameters (as returned by DateSelector generated HTML).
Parameters:
key - A String with the selector name. True if keys are found. |
| containsKey | | boolean containsKey(Object key)(Code) | | Determine whether a given key has been inserted. All keys are
stored in lowercase strings, so override method to account for
this.
Parameters:
key - An Object with the key to search for. True if the object is found. |
| convert | | String convert(String value)(Code) | | Trims the string data and applies the conversion specified in
the property given by URL_CASE_FOLDING. It returns a new
string so that it does not destroy the value data.
Parameters:
value - A String to be processed. A new String converted to lowercase and trimmed. |
| get | | String get(String name)(Code) | | Return a String for the given name. If the name does not
exist, return null. It is the same as the getString() method
however has been added for simplicity when working with
template tools such as Velocity which allow you to do
something like this:
$data.Parameters.form_variable_name
Parameters:
name - A String with the name. A String. |
| getBigDecimal | | BigDecimal getBigDecimal(String name, BigDecimal defaultValue)(Code) | | Return a BigDecimal for the given name. If the name does not
exist, return 0.0.
Parameters:
name - A String with the name.
Parameters:
defaultValue - The default value. A BigDecimal. |
| getBigDecimal | | BigDecimal getBigDecimal(String name)(Code) | | Return a BigDecimal for the given name. If the name does not
exist, return null.
Parameters:
name - A String with the name. A BigDecimal. |
| getBigDecimals | | BigDecimal[] getBigDecimals(String name)(Code) | | Return an array of BigDecimals for the given name. If the name
does not exist, return null.
Parameters:
name - A String with the name. A BigDecimal[]. |
| getBool | | Boolean getBool(String name, boolean defaultValue)(Code) | | Return a Boolean for the given name. If the name does not
exist, return defaultValue.
Parameters:
name - A String with the name.
Parameters:
defaultValue - The default value. A Boolean.ValueParser.getBooleanObject |
| getBoolean | | boolean getBoolean(String name, boolean defaultValue)(Code) | | Return a boolean for the given name. If the name does not
exist, return defaultValue.
Parameters:
name - A String with the name.
Parameters:
defaultValue - The default value. A boolean. |
| getBoolean | | boolean getBoolean(String name)(Code) | | Return a boolean for the given name. If the name does not
exist, return false.
Parameters:
name - A String with the name. A boolean. |
| getBooleanObject | | Boolean getBooleanObject(String name)(Code) | | Returns a Boolean object for the given name. If the parameter
does not exist or can not be parsed as a boolean, null is returned.
Valid values for true: true, on, 1, yes
Valid values for false: false, off, 0, no
The string is compared without reguard to case.
Parameters:
name - A String with the name. A Boolean. |
| getBooleanObject | | Boolean getBooleanObject(String name, Boolean defaultValue)(Code) | | Returns a Boolean object for the given name. If the parameter
does not exist or can not be parsed as a boolean, the defaultValue
is returned.
Valid values for true: true, on, 1, yes
Valid values for false: false, off, 0, no
The string is compared without reguard to case.
Parameters:
name - A String with the name. A Boolean. |
| getByte | | byte getByte(String name, byte defaultValue)(Code) | | Return a byte for the given name. If the name does not exist,
return defaultValue.
Parameters:
name - A String with the name.
Parameters:
defaultValue - The default value. A byte. |
| getByte | | byte getByte(String name)(Code) | | Return a byte for the given name. If the name does not exist,
return 0.
Parameters:
name - A String with the name. A byte. |
| getByteObject | | Byte getByteObject(String name, Byte defaultValue)(Code) | | Return a byte for the given name. If the name does not exist,
return defaultValue.
Parameters:
name - A String with the name.
Parameters:
defaultValue - The default value. A byte. |
| getByteObject | | Byte getByteObject(String name)(Code) | | Return a byte for the given name. If the name does not exist,
return 0.
Parameters:
name - A String with the name. A byte. |
| getCharacterEncoding | | String getCharacterEncoding()(Code) | | Get the character encoding that will be used by this ValueParser.
|
| getDate | | Date getDate(String name, DateFormat df, Date defaultValue)(Code) | | Returns a java.util.Date object. String is parsed by supplied
DateFormat. If the name does not exist, return the
defaultValue.
Parameters:
name - A String with the name.
Parameters:
df - A DateFormat.
Parameters:
defaultValue - The default value. A Date. |
| getDate | | Date getDate(String name)(Code) | | Returns a java.util.Date object. If there are DateSelector
style parameters then these are used. If not and there is a
parameter 'name' then this is parsed by DateFormat. If the
name does not exist, return null.
Parameters:
name - A String with the name. A Date. |
| getDate | | Date getDate(String name, DateFormat df)(Code) | | Returns a java.util.Date object. String is parsed by supplied
DateFormat. If the name does not exist, return null.
Parameters:
name - A String with the name.
Parameters:
df - A DateFormat. A Date. |
| getDouble | | double getDouble(String name, double defaultValue)(Code) | | Return a double for the given name. If the name does not
exist, return defaultValue.
Parameters:
name - A String with the name.
Parameters:
defaultValue - The default value. A double. |
| getDouble | | double getDouble(String name)(Code) | | Return a double for the given name. If the name does not
exist, return 0.0.
Parameters:
name - A String with the name. A double. |
| getDoubleObject | | Double getDoubleObject(String name, Double defaultValue)(Code) | | Return a Double for the given name. If the name does not
exist, return defaultValue.
Parameters:
name - A String with the name.
Parameters:
defaultValue - The default value. A double. |
| getDoubleObject | | Double getDoubleObject(String name)(Code) | | Return a Double for the given name. If the name does not
exist, return null.
Parameters:
name - A String with the name. A double. |
| getDoubleObjects | | Double[] getDoubleObjects(String name)(Code) | | Return an array of doubles for the given name. If the name does
not exist, return null.
Parameters:
name - A String with the name. A double[]. |
| getDoubles | | double[] getDoubles(String name)(Code) | | Return an array of doubles for the given name. If the name does
not exist, return null.
Parameters:
name - A String with the name. A double[]. |
| getFloat | | float getFloat(String name, float defaultValue)(Code) | | Return a float for the given name. If the name does not
exist, return defaultValue.
Parameters:
name - A String with the name.
Parameters:
defaultValue - The default value. A float. |
| getFloat | | float getFloat(String name)(Code) | | Return a float for the given name. If the name does not
exist, return 0.0.
Parameters:
name - A String with the name. A float. |
| getFloatObject | | Float getFloatObject(String name, Float defaultValue)(Code) | | Return a Float for the given name. If the name does not
exist, return defaultValue.
Parameters:
name - A String with the name.
Parameters:
defaultValue - The default value. A Float. |
| getFloatObject | | Float getFloatObject(String name)(Code) | | Return a float for the given name. If the name does not
exist, return null.
Parameters:
name - A String with the name. A Float. |
| getFloatObjects | | Float[] getFloatObjects(String name)(Code) | | Return an array of floats for the given name. If the name does
not exist, return null.
Parameters:
name - A String with the name. A float[]. |
| getFloats | | float[] getFloats(String name)(Code) | | Return an array of floats for the given name. If the name does
not exist, return null.
Parameters:
name - A String with the name. A float[]. |
| getInt | | int getInt(String name, int defaultValue)(Code) | | Return an int for the given name. If the name does not exist,
return defaultValue.
Parameters:
name - A String with the name.
Parameters:
defaultValue - The default value. An int. |
| getInt | | int getInt(String name)(Code) | | Return an int for the given name. If the name does not exist,
return 0.
Parameters:
name - A String with the name. An int. |
| getIntObject | | Integer getIntObject(String name, Integer defaultValue)(Code) | | Return an Integer for the given name. If the name does not exist,
return defaultValue.
Parameters:
name - A String with the name.
Parameters:
defaultValue - The default value. An Integer. |
| getIntObject | | Integer getIntObject(String name)(Code) | | Return an Integer for the given name. If the name does not exist,
return null.
Parameters:
name - A String with the name. An Integer. |
| getIntObjects | | Integer[] getIntObjects(String name)(Code) | | Return an array of Integers for the given name. If the name
does not exist, return null.
Parameters:
name - A String with the name. An Integer[]. |
| getInteger | | Integer getInteger(String name, int defaultValue)(Code) | | Return an Integer for the given name. If the name does not
exist, return defaultValue.
Parameters:
name - A String with the name.
Parameters:
defaultValue - The default value. An Integer.ValueParser.getIntObject |
| getInteger | | Integer getInteger(String name, Integer defaultValue)(Code) | | Return an Integer for the given name. If the name does not
exist, return defaultValue. You cannot pass in a null here for
the default value.
Parameters:
name - A String with the name.
Parameters:
defaultValue - The default value. An Integer.ValueParser.getIntObject |
| getIntegers | | Integer[] getIntegers(String name)(Code) | | Return an array of Integers for the given name. If the name
does not exist, return null.
Parameters:
name - A String with the name. An Integer[].ValueParser.getIntObjects |
| getInts | | int[] getInts(String name)(Code) | | Return an array of ints for the given name. If the name does
not exist, return null.
Parameters:
name - A String with the name. An int[]. |
| getKeys | | Object[] getKeys()(Code) | | Returns all the available parameter names.
A object array with the keys. |
| getLong | | long getLong(String name, long defaultValue)(Code) | | Return a long for the given name. If the name does not exist,
return defaultValue.
Parameters:
name - A String with the name.
Parameters:
defaultValue - The default value. A long. |
| getLong | | long getLong(String name)(Code) | | Return a long for the given name. If the name does not exist,
return 0.
Parameters:
name - A String with the name. A long. |
| getLongObject | | Long getLongObject(String name, Long defaultValue)(Code) | | Return a Long for the given name. If the name does not exist,
return defaultValue.
Parameters:
name - A String with the name.
Parameters:
defaultValue - The default value. A Long. |
| getLongObject | | Long getLongObject(String name)(Code) | | Return a Long for the given name. If the name does not exist,
return null.
Parameters:
name - A String with the name. A Long. |
| getLongObjects | | Long[] getLongObjects(String name)(Code) | | Return an array of Longs for the given name. If the name does
not exist, return null.
Parameters:
name - A String with the name. A Long[]. |
| getLongs | | long[] getLongs(String name)(Code) | | Return an array of longs for the given name. If the name does
not exist, return null.
Parameters:
name - A String with the name. A long[]. |
| getNumberKey | | NumberKey getNumberKey(String name)(Code) | | Return an NumberKey for the given name. If the name does not
exist, return null.
Parameters:
name - A String with the name. An NumberKey. |
| getObject | | Object getObject(String name)(Code) | | Return an Object for the given name. If the name does not
exist, return null.
Parameters:
name - A String with the name. An Object. |
| getObjects | | Object[] getObjects(String name)(Code) | | Return an array of Objects for the given name. If the name
does not exist, return null.
Parameters:
name - A String with the name. An Object[]. |
| getString | | String getString(String name)(Code) | | Return a String for the given name. If the name does not
exist, return null.
Parameters:
name - A String with the name. A String. |
| getString | | String getString(String name, String defaultValue)(Code) | | Return a String for the given name. If the name does not
exist, return the defaultValue.
Parameters:
name - A String with the name.
Parameters:
defaultValue - The default value. A String. |
| getStringKey | | StringKey getStringKey(String name)(Code) | | Return an NumberKey for the given name. If the name does not
exist, return null.
Parameters:
name - A String with the name. An StringKey. |
| getStrings | | String[] getStrings(String name)(Code) | | Return an array of Strings for the given name. If the name
does not exist, return null.
Parameters:
name - A String with the name. A String[]. |
| getStrings | | String[] getStrings(String name, String[] defaultValue)(Code) | | Return an array of Strings for the given name. If the name
does not exist, return the defaultValue.
Parameters:
name - A String with the name.
Parameters:
defaultValue - The default value. A String[]. |
| keySet | | Set keySet()(Code) | | Gets the keys.
A Set of the keys. |
| remove | | Object remove(String name)(Code) | | Removes the named parameter from the contained hashtable. Wraps to the
contained Hashtable.remove().
The value that was mapped to the key (a String[])or null if the key was not mapped. |
| setCharacterEncoding | | void setCharacterEncoding(String s)(Code) | | Set the character encoding that will be used by this ValueParser.
|
| setProperties | | void setProperties(Object bean) throws Exception(Code) | | Uses bean introspection to set writable properties of bean from
the parameters, where a (case-insensitive) name match between
the bean property and the parameter is looked for.
Parameters:
bean - An Object.
exception:
Exception - a generic exception. |
| setString | | void setString(String name, String value)(Code) | | Set a parameter to a specific value.
This is useful if you want your action to override the values
of the parameters for the screen to use.
Parameters:
name - The name of the parameter.
Parameters:
value - The value to set. |
| setStrings | | void setStrings(String name, String[] values)(Code) | | Set a parameter to a specific value.
This is useful if you want your action to override the values
of the parameters for the screen to use.
Parameters:
name - The name of the parameter.
Parameters:
values - The value to set. |
| toString | | String toString()(Code) | | Simple method that attempts to get a toString() representation
of this object. It doesn't do well with String[]'s though.
A String. |
|
|