|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.plexus.summit.parameters.BaseParameterConverter
Base implementation of a ParameterConverter
which relies
on an underlying Map of name/value pairs where each value is an
array of strings (even if it contains a single value). For example,
the Map returned by HttpRequest#getParameterMap()
.
Field Summary | |
protected java.lang.String |
characterEncoding
The character encoding to use when converting to byte arrays. |
protected java.util.Map |
parameters
Map used to store the parameters that were parsed. |
Constructor Summary | |
BaseParameterConverter(java.util.Map parameters)
Constructor that takes a map of parameters and uses the default character encoding, "US-ASCII", when converting to byte arrays. |
|
BaseParameterConverter(java.util.Map parameters,
java.lang.String characterEncoding)
Constructor that takes a map of parameters and a character encoding that is used when converting to byte arrays. |
Method Summary | |
boolean |
containsKey(java.lang.Object key)
Determine whether a given key has been inserted |
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)
Return a Boolean for the given name. |
java.lang.Boolean |
getBool(java.lang.String name,
boolean defaultValue)
Return a Boolean for the given name. |
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. |
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. |
byte[] |
getBytes(java.lang.String name)
Return an array of bytes for the given name. |
java.util.Date |
getDate(java.lang.String name)
Returns a Date object. |
java.util.Date |
getDate(java.lang.String name,
java.text.DateFormat df)
Returns a Date object. |
java.util.Date |
getDate(java.lang.String name,
java.text.DateFormat df,
java.util.Date defaultValue)
Returns a 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. |
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. |
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)
Return an Integer for the given name. |
java.lang.Integer |
getInteger(java.lang.String name,
int defaultValue)
Return an Integer for the given name. |
java.lang.Integer |
getInteger(java.lang.String name,
java.lang.Integer def)
Return an Integer for the given name. |
java.lang.Integer[] |
getIntegers(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()
Get an array of all the 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[] |
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. |
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.util.Map |
getParametersMap()
|
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. |
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.Iterator |
keys()
Get an Iterator for the parameter names. |
java.lang.String |
toString()
Provides a textual representation of the parameters represented by this object. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected java.util.Map parameters
protected java.lang.String characterEncoding
Constructor Detail |
public BaseParameterConverter(java.util.Map parameters)
parameters
- A map of name/value pairs representing parameters.
java.lang.NullPointerException
- If the parameters map is null.public BaseParameterConverter(java.util.Map parameters, java.lang.String characterEncoding)
parameters
- A map of name/value pairs representing parameters.characterEncoding
- The character encoding used to convert byte arrays.
If the specified value is null, the default encoding of
"US-ASCII" is used.
java.lang.NullPointerException
- If the parameters map is null.Method Detail |
public java.util.Map getParametersMap()
public boolean containsKey(java.lang.Object key)
ParameterConverter
containsKey
in interface ParameterConverter
key
- An Object with the key to search for.
public java.util.Iterator keys()
ParameterConverter
keys
in interface ParameterConverter
public java.lang.Object[] getKeys()
ParameterConverter
getKeys
in interface ParameterConverter
public boolean getBoolean(java.lang.String name, boolean defaultValue)
ParameterConverter
getBoolean
in interface ParameterConverter
name
- A String with the name.defaultValue
- The default value.
public boolean getBoolean(java.lang.String name)
ParameterConverter
getBoolean
in interface ParameterConverter
name
- A String with the name.
public java.lang.Boolean getBool(java.lang.String name, boolean defaultValue)
ParameterConverter
getBool
in interface ParameterConverter
name
- A String with the name.defaultValue
- The default value.
public java.lang.Boolean getBool(java.lang.String name)
ParameterConverter
getBool
in interface ParameterConverter
name
- A String with the name.
public double getDouble(java.lang.String name, double defaultValue)
ParameterConverter
getDouble
in interface ParameterConverter
name
- A String with the name.defaultValue
- The default value.
public double getDouble(java.lang.String name)
ParameterConverter
getDouble
in interface ParameterConverter
name
- A String with the name.
public float getFloat(java.lang.String name, float defaultValue)
ParameterConverter
getFloat
in interface ParameterConverter
name
- A String with the name.defaultValue
- The default value.
public float getFloat(java.lang.String name)
ParameterConverter
getFloat
in interface ParameterConverter
name
- A String with the name.
public java.math.BigDecimal getBigDecimal(java.lang.String name, java.math.BigDecimal defaultValue)
ParameterConverter
getBigDecimal
in interface ParameterConverter
name
- A String with the name.defaultValue
- The default value.
public java.math.BigDecimal getBigDecimal(java.lang.String name)
ParameterConverter
getBigDecimal
in interface ParameterConverter
name
- A String with the name.
public java.math.BigDecimal[] getBigDecimals(java.lang.String name)
ParameterConverter
getBigDecimals
in interface ParameterConverter
name
- A String with the name.
public int getInt(java.lang.String name, int defaultValue)
ParameterConverter
getInt
in interface ParameterConverter
name
- A String with the name.defaultValue
- The default value.
public int getInt(java.lang.String name)
ParameterConverter
getInt
in interface ParameterConverter
name
- A String with the name.
public java.lang.Integer getInteger(java.lang.String name, int defaultValue)
ParameterConverter
getInteger
in interface ParameterConverter
name
- A String with the name.defaultValue
- The default value.
public java.lang.Integer getInteger(java.lang.String name, java.lang.Integer def)
ParameterConverter
getInteger
in interface ParameterConverter
name
- A String with the name.def
- The default value.
public java.lang.Integer getInteger(java.lang.String name)
ParameterConverter
getInteger
in interface ParameterConverter
name
- A String with the name.
public int[] getInts(java.lang.String name)
ParameterConverter
getInts
in interface ParameterConverter
name
- A String with the name.
public java.lang.Integer[] getIntegers(java.lang.String name)
ParameterConverter
getIntegers
in interface ParameterConverter
name
- A String with the name.
public long getLong(java.lang.String name, long defaultValue)
ParameterConverter
getLong
in interface ParameterConverter
name
- A String with the name.defaultValue
- The default value.
public long getLong(java.lang.String name)
ParameterConverter
getLong
in interface ParameterConverter
name
- A String with the name.
public long[] getLongs(java.lang.String name)
ParameterConverter
getLongs
in interface ParameterConverter
name
- A String with the name.
public java.lang.Long[] getLongObjects(java.lang.String name)
ParameterConverter
getLongObjects
in interface ParameterConverter
name
- A String with the name.
public byte getByte(java.lang.String name, byte defaultValue)
ParameterConverter
getByte
in interface ParameterConverter
name
- A String with the name.defaultValue
- The default value.
public byte getByte(java.lang.String name)
ParameterConverter
getByte
in interface ParameterConverter
name
- A String with the name.
public byte[] getBytes(java.lang.String name) throws java.io.UnsupportedEncodingException
ParameterConverter
getBytes
in interface ParameterConverter
name
- A String with the name.
java.io.UnsupportedEncodingException
public java.lang.String getString(java.lang.String name)
ParameterConverter
getString
in interface ParameterConverter
name
- A String with the name.
public java.lang.String get(java.lang.String name)
ParameterConverter
$data.Parameters.form_variable_name
get
in interface ParameterConverter
name
- A String with the name.
public java.lang.String getString(java.lang.String name, java.lang.String defaultValue)
ParameterConverter
getString
in interface ParameterConverter
name
- A String with the name.defaultValue
- The default value.
public java.lang.String[] getStrings(java.lang.String name)
ParameterConverter
getStrings
in interface ParameterConverter
name
- A String with the name.
public java.lang.String[] getStrings(java.lang.String name, java.lang.String[] defaultValue)
ParameterConverter
getStrings
in interface ParameterConverter
name
- A String with the name.defaultValue
- The default value.
public java.lang.Object getObject(java.lang.String name)
ParameterConverter
getObject
in interface ParameterConverter
name
- A String with the name.
public java.lang.Object[] getObjects(java.lang.String name)
ParameterConverter
getObjects
in interface ParameterConverter
name
- A String with the name.
public java.util.Date getDate(java.lang.String name, java.text.DateFormat df, java.util.Date defaultValue)
ParameterConverter
Date
object. String is parsed by supplied
DateFormat. If the name does not exist, return the
defaultValue.
getDate
in interface ParameterConverter
name
- A String with the name.df
- A DateFormat.defaultValue
- The default value.
public java.util.Date getDate(java.lang.String name, java.text.DateFormat df)
ParameterConverter
Date
object. String is parsed by supplied
DateFormat. If the name does not exist, return null.
getDate
in interface ParameterConverter
name
- A String with the name.df
- A DateFormat.
public java.util.Date getDate(java.lang.String name)
ParameterConverter
Date
object. String is parsed by supplied
DateFormat. If the name does not exist, return null.
getDate
in interface ParameterConverter
name
- A String with the name.
public java.lang.String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |