|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ValueParser
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:
Field Summary | |
---|---|
static java.lang.String |
URL_CASE_FOLDING
Deprecated. Use ParserUtils.URL_CASE_FOLDING_KEY |
static java.lang.String |
URL_CASE_FOLDING_LOWER
Deprecated. Use ParserUtils.URL_CASE_FOLDING_LOWER_VALUE |
static java.lang.String |
URL_CASE_FOLDING_NONE
Deprecated. Use ParserUtils.URL_CASE_FOLDING_NONE_VALUE |
static java.lang.String |
URL_CASE_FOLDING_UPPER
Deprecated. Use ParserUtils.URL_CASE_FOLDING_UPPER_VALUE |
Method Summary | |
---|---|
void |
add(java.lang.String name,
double value)
Add a name/value pair into this object. |
void |
add(java.lang.String name,
int value)
Add a name/value pair into this object. |
void |
add(java.lang.String name,
java.lang.Integer value)
Add a name/value pair into this object. |
void |
add(java.lang.String name,
long value)
Add a name/value pair into this object. |
void |
add(java.lang.String name,
java.lang.String value)
Add a name/value pair into this object. |
void |
add(java.lang.String name,
java.lang.String[] value)
Add an array of Strings for a key. |
void |
append(java.lang.String name,
java.lang.String value)
Deprecated. Use add(name, value) instead. |
void |
clear()
Clear all name/value pairs out of this object. |
boolean |
containsDateSelectorKeys(java.lang.String key)
Check for existence of key_day, key_month and key_year parameters (as returned by DateSelector generated HTML). |
boolean |
containsKey(java.lang.Object key)
Determine whether a given key has been inserted. |
java.lang.String |
convert(java.lang.String value)
Trims the string data and applies the conversion specified in the property given by URL_CASE_FOLDING. |
java.lang.String |
get(java.lang.String name)
Return a String for the given name. |
java.math.BigDecimal |
getBigDecimal(java.lang.String name)
Return a BigDecimal for the given name. |
java.math.BigDecimal |
getBigDecimal(java.lang.String name,
java.math.BigDecimal defaultValue)
Return a BigDecimal for the given name. |
java.math.BigDecimal[] |
getBigDecimals(java.lang.String name)
Return an array of BigDecimals for the given name. |
java.lang.Boolean |
getBool(java.lang.String name)
Deprecated. use getBooleanObject(java.lang.String) instead |
java.lang.Boolean |
getBool(java.lang.String name,
boolean defaultValue)
Deprecated. use getBooleanObject(java.lang.String) instead |
boolean |
getBoolean(java.lang.String name)
Return a boolean for the given name. |
boolean |
getBoolean(java.lang.String name,
boolean defaultValue)
Return a boolean for the given name. |
java.lang.Boolean |
getBooleanObject(java.lang.String name)
Returns a Boolean object for the given name. |
java.lang.Boolean |
getBooleanObject(java.lang.String name,
java.lang.Boolean defaultValue)
Returns a Boolean object for the given name. |
byte |
getByte(java.lang.String name)
Return a byte for the given name. |
byte |
getByte(java.lang.String name,
byte defaultValue)
Return a byte for the given name. |
java.lang.Byte |
getByteObject(java.lang.String name)
Return a byte for the given name. |
java.lang.Byte |
getByteObject(java.lang.String name,
java.lang.Byte defaultValue)
Return a byte for the given name. |
byte[] |
getBytes(java.lang.String name)
Return an array of bytes for the given name. |
java.lang.String |
getCharacterEncoding()
Get the character encoding that will be used by this ValueParser. |
java.util.Date |
getDate(java.lang.String name)
Returns a java.util.Date object. |
java.util.Date |
getDate(java.lang.String name,
java.text.DateFormat df)
Returns a java.util.Date object. |
java.util.Date |
getDate(java.lang.String name,
java.text.DateFormat df,
java.util.Date defaultValue)
Returns a java.util.Date object. |
double |
getDouble(java.lang.String name)
Return a double for the given name. |
double |
getDouble(java.lang.String name,
double defaultValue)
Return a double for the given name. |
java.lang.Double |
getDoubleObject(java.lang.String name)
Return a Double for the given name. |
java.lang.Double |
getDoubleObject(java.lang.String name,
java.lang.Double defaultValue)
Return a Double for the given name. |
java.lang.Double[] |
getDoubleObjects(java.lang.String name)
Return an array of doubles for the given name. |
double[] |
getDoubles(java.lang.String name)
Return an array of doubles for the given name. |
float |
getFloat(java.lang.String name)
Return a float for the given name. |
float |
getFloat(java.lang.String name,
float defaultValue)
Return a float for the given name. |
java.lang.Float |
getFloatObject(java.lang.String name)
Return a float for the given name. |
java.lang.Float |
getFloatObject(java.lang.String name,
java.lang.Float defaultValue)
Return a Float for the given name. |
java.lang.Float[] |
getFloatObjects(java.lang.String name)
Return an array of floats for the given name. |
float[] |
getFloats(java.lang.String name)
Return an array of floats for the given name. |
int |
getInt(java.lang.String name)
Return an int for the given name. |
int |
getInt(java.lang.String name,
int defaultValue)
Return an int for the given name. |
java.lang.Integer |
getInteger(java.lang.String name)
Deprecated. use getIntObject(java.lang.String, java.lang.Integer) instead |
java.lang.Integer |
getInteger(java.lang.String name,
int defaultValue)
Deprecated. use getIntObject(java.lang.String, java.lang.Integer) instead |
java.lang.Integer |
getInteger(java.lang.String name,
java.lang.Integer defaultValue)
Deprecated. use getIntObject(java.lang.String, java.lang.Integer) instead |
java.lang.Integer[] |
getIntegers(java.lang.String name)
Deprecated. use getIntObjects(java.lang.String) instead |
java.lang.Integer |
getIntObject(java.lang.String name)
Return an Integer for the given name. |
java.lang.Integer |
getIntObject(java.lang.String name,
java.lang.Integer defaultValue)
Return an Integer for the given name. |
java.lang.Integer[] |
getIntObjects(java.lang.String name)
Return an array of Integers for the given name. |
int[] |
getInts(java.lang.String name)
Return an array of ints for the given name. |
java.lang.Object[] |
getKeys()
Returns all the available parameter names. |
long |
getLong(java.lang.String name)
Return a long for the given name. |
long |
getLong(java.lang.String name,
long defaultValue)
Return a long for the given name. |
java.lang.Long |
getLongObject(java.lang.String name)
Return a Long for the given name. |
java.lang.Long |
getLongObject(java.lang.String name,
java.lang.Long defaultValue)
Return a Long for the given name. |
java.lang.Long[] |
getLongObjects(java.lang.String name)
Return an array of Longs for the given name. |
long[] |
getLongs(java.lang.String name)
Return an array of longs for the given name. |
org.apache.torque.om.NumberKey |
getNumberKey(java.lang.String name)
Deprecated. no replacement |
java.lang.Object |
getObject(java.lang.String name)
Return an Object for the given name. |
java.lang.Object[] |
getObjects(java.lang.String name)
Return an array of Objects for the given name. |
java.lang.String |
getString(java.lang.String name)
Return a String for the given name. |
java.lang.String |
getString(java.lang.String name,
java.lang.String defaultValue)
Return a String for the given name. |
org.apache.torque.om.StringKey |
getStringKey(java.lang.String name)
Deprecated. no replacement |
java.lang.String[] |
getStrings(java.lang.String name)
Return an array of Strings for the given name. |
java.lang.String[] |
getStrings(java.lang.String name,
java.lang.String[] defaultValue)
Return an array of Strings for the given name. |
java.util.Enumeration |
keys()
Deprecated. use keySet() instead. |
java.util.Set |
keySet()
Gets the keys. |
java.lang.Object |
remove(java.lang.String name)
Removes the named parameter from the contained hashtable. |
void |
setCharacterEncoding(java.lang.String s)
Set the character encoding that will be used by this ValueParser. |
void |
setProperties(java.lang.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(java.lang.String name,
java.lang.String value)
Set a parameter to a specific value. |
void |
setStrings(java.lang.String name,
java.lang.String[] values)
Set a parameter to a specific value. |
java.lang.String |
toString()
Simple method that attempts to get a toString() representation of this object. |
Field Detail |
---|
static final java.lang.String URL_CASE_FOLDING
static final java.lang.String URL_CASE_FOLDING_NONE
static final java.lang.String URL_CASE_FOLDING_LOWER
static final java.lang.String URL_CASE_FOLDING_UPPER
Method Detail |
---|
void clear()
void setCharacterEncoding(java.lang.String s)
java.lang.String getCharacterEncoding()
java.lang.String convert(java.lang.String value)
value
- A String to be processed.
void add(java.lang.String name, double value)
name
- A String with the name.value
- A double with the value.void add(java.lang.String name, int value)
name
- A String with the name.value
- An int with the value.void add(java.lang.String name, java.lang.Integer value)
name
- A String with the name.value
- An Integer with the value.void add(java.lang.String name, long value)
name
- A String with the name.value
- A long with the value.void add(java.lang.String name, java.lang.String value)
name
- A String with the name.value
- A long with the value.void append(java.lang.String name, java.lang.String value)
name
- A String with the name.value
- A String with the value.void add(java.lang.String name, java.lang.String[] value)
name
- A String with the name.value
- A String Array.java.lang.Object remove(java.lang.String name)
Hashtable.remove()
.
String[]
)
or null
if the key was not mapped.boolean containsKey(java.lang.Object key)
key
- An Object with the key to search for.
boolean containsDateSelectorKeys(java.lang.String key)
key
- A String with the selector name.
java.util.Enumeration keys()
keySet()
instead.
enumerator
of the keys.java.util.Set keySet()
Set
of the keys.java.lang.Object[] getKeys()
boolean getBoolean(java.lang.String name, boolean defaultValue)
name
- A String with the name.defaultValue
- The default value.
boolean getBoolean(java.lang.String name)
name
- A String with the name.
java.lang.Boolean getBool(java.lang.String name, boolean defaultValue)
getBooleanObject(java.lang.String)
instead
name
- A String with the name.defaultValue
- The default value.
java.lang.Boolean getBool(java.lang.String name)
getBooleanObject(java.lang.String)
instead
name
- A String with the name.
java.lang.Boolean getBooleanObject(java.lang.String name)
Valid values for true: true, on, 1, yes
Valid values for false: false, off, 0, no
The string is compared without reguard to case.
name
- A String with the name.
java.lang.Boolean getBooleanObject(java.lang.String name, java.lang.Boolean defaultValue)
Valid values for true: true, on, 1, yes
Valid values for false: false, off, 0, no
The string is compared without reguard to case.
name
- A String with the name.
double getDouble(java.lang.String name, double defaultValue)
name
- A String with the name.defaultValue
- The default value.
double getDouble(java.lang.String name)
name
- A String with the name.
double[] getDoubles(java.lang.String name)
name
- A String with the name.
java.lang.Double getDoubleObject(java.lang.String name, java.lang.Double defaultValue)
name
- A String with the name.defaultValue
- The default value.
java.lang.Double getDoubleObject(java.lang.String name)
name
- A String with the name.
java.lang.Double[] getDoubleObjects(java.lang.String name)
name
- A String with the name.
float getFloat(java.lang.String name, float defaultValue)
name
- A String with the name.defaultValue
- The default value.
float getFloat(java.lang.String name)
name
- A String with the name.
float[] getFloats(java.lang.String name)
name
- A String with the name.
java.lang.Float getFloatObject(java.lang.String name, java.lang.Float defaultValue)
name
- A String with the name.defaultValue
- The default value.
java.lang.Float getFloatObject(java.lang.String name)
name
- A String with the name.
java.lang.Float[] getFloatObjects(java.lang.String name)
name
- A String with the name.
java.math.BigDecimal getBigDecimal(java.lang.String name, java.math.BigDecimal defaultValue)
name
- A String with the name.defaultValue
- The default value.
java.math.BigDecimal getBigDecimal(java.lang.String name)
null
.
name
- A String with the name.
java.math.BigDecimal[] getBigDecimals(java.lang.String name)
name
- A String with the name.
int getInt(java.lang.String name, int defaultValue)
name
- A String with the name.defaultValue
- The default value.
int getInt(java.lang.String name)
name
- A String with the name.
java.lang.Integer getIntObject(java.lang.String name, java.lang.Integer defaultValue)
name
- A String with the name.defaultValue
- The default value.
java.lang.Integer getIntObject(java.lang.String name)
name
- A String with the name.
java.lang.Integer getInteger(java.lang.String name, int defaultValue)
getIntObject(java.lang.String, java.lang.Integer)
instead
name
- A String with the name.defaultValue
- The default value.
java.lang.Integer getInteger(java.lang.String name, java.lang.Integer defaultValue)
getIntObject(java.lang.String, java.lang.Integer)
instead
name
- A String with the name.defaultValue
- The default value.
java.lang.Integer getInteger(java.lang.String name)
getIntObject(java.lang.String, java.lang.Integer)
instead
null
.
name
- A String with the name.
int[] getInts(java.lang.String name)
name
- A String with the name.
java.lang.Integer[] getIntegers(java.lang.String name)
getIntObjects(java.lang.String)
instead
name
- A String with the name.
java.lang.Integer[] getIntObjects(java.lang.String name)
name
- A String with the name.
long getLong(java.lang.String name, long defaultValue)
name
- A String with the name.defaultValue
- The default value.
long getLong(java.lang.String name)
name
- A String with the name.
java.lang.Long getLongObject(java.lang.String name, java.lang.Long defaultValue)
name
- A String with the name.defaultValue
- The default value.
java.lang.Long getLongObject(java.lang.String name)
name
- A String with the name.
long[] getLongs(java.lang.String name)
name
- A String with the name.
java.lang.Long[] getLongObjects(java.lang.String name)
name
- A String with the name.
byte getByte(java.lang.String name, byte defaultValue)
name
- A String with the name.defaultValue
- The default value.
byte getByte(java.lang.String name)
name
- A String with the name.
byte[] getBytes(java.lang.String name) throws java.io.UnsupportedEncodingException
name
- A String with the name.
java.io.UnsupportedEncodingException
java.lang.Byte getByteObject(java.lang.String name, java.lang.Byte defaultValue)
name
- A String with the name.defaultValue
- The default value.
java.lang.Byte getByteObject(java.lang.String name)
name
- A String with the name.
java.lang.String getString(java.lang.String name)
name
- A String with the name.
java.lang.String get(java.lang.String name)
$data.Parameters.form_variable_name
name
- A String with the name.
java.lang.String getString(java.lang.String name, java.lang.String defaultValue)
name
- A String with the name.defaultValue
- The default value.
void setString(java.lang.String name, java.lang.String value)
name
- The name of the parameter.value
- The value to set.java.lang.String[] getStrings(java.lang.String name)
name
- A String with the name.
java.lang.String[] getStrings(java.lang.String name, java.lang.String[] defaultValue)
name
- A String with the name.defaultValue
- The default value.
void setStrings(java.lang.String name, java.lang.String[] values)
name
- The name of the parameter.values
- The value to set.java.lang.Object getObject(java.lang.String name)
name
- A String with the name.
java.lang.Object[] getObjects(java.lang.String name)
name
- A String with the name.
java.util.Date getDate(java.lang.String name, java.text.DateFormat df, java.util.Date defaultValue)
name
- A String with the name.df
- A DateFormat.defaultValue
- The default value.
java.util.Date getDate(java.lang.String name)
name
- A String with the name.
java.util.Date getDate(java.lang.String name, java.text.DateFormat df)
name
- A String with the name.df
- A DateFormat.
org.apache.torque.om.NumberKey getNumberKey(java.lang.String name)
name
- A String with the name.
org.apache.torque.om.StringKey getStringKey(java.lang.String name)
name
- A String with the name.
void setProperties(java.lang.Object bean) throws java.lang.Exception
bean
- An Object.
java.lang.Exception
- a generic exception.java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |