org.apache.velocity.tools.generic
Class ValueParser
java.lang.Object
org.apache.velocity.tools.generic.AbstractLockConfig
org.apache.velocity.tools.generic.LocaleConfig
org.apache.velocity.tools.generic.ConversionTool
org.apache.velocity.tools.generic.ValueParser
- Direct Known Subclasses:
- ParameterTool
@DefaultKey(value="parser")
public class ValueParser
- extends ConversionTool
Utility class for easy parsing of String values held in a Map.
This comes in very handy when parsing parameters.
TODO: someone doing java configuration ought to be able to put a source Map
in the tool properties, allowing this to be used like other tools
- Since:
- VelocityTools 1.2
- Version:
- $Revision: 545420 $ $Date: 2007-06-07 22:21:52 -0700 (Thu, 07 Jun 2007) $
- Author:
- Nathan Bubna
Field Summary |
private java.util.Map |
source
|
Method Summary |
boolean |
exists(java.lang.String key)
Convenience method for checking whether a certain parameter exists. |
java.lang.Object |
get(java.lang.String key)
Convenience method for use in Velocity templates. |
java.lang.Boolean |
getBoolean(java.lang.String key)
|
boolean |
getBoolean(java.lang.String key,
boolean alternate)
|
java.lang.Boolean |
getBoolean(java.lang.String key,
java.lang.Boolean alternate)
|
java.lang.Boolean[] |
getBooleans(java.lang.String key)
|
java.lang.Double |
getDouble(java.lang.String key)
|
double |
getDouble(java.lang.String key,
double alternate)
|
java.lang.Double |
getDouble(java.lang.String key,
java.lang.Double alternate)
|
double[] |
getDoubles(java.lang.String key)
|
int |
getInt(java.lang.String key,
int alternate)
|
java.lang.Integer |
getInteger(java.lang.String key)
|
java.lang.Integer |
getInteger(java.lang.String key,
java.lang.Integer alternate)
|
int[] |
getInts(java.lang.String key)
|
java.util.Locale |
getLocale(java.lang.String key)
|
java.util.Locale |
getLocale(java.lang.String key,
java.util.Locale alternate)
|
java.util.Locale[] |
getLocales(java.lang.String key)
|
java.lang.Number |
getNumber(java.lang.String key)
|
java.lang.Number |
getNumber(java.lang.String key,
java.lang.Number alternate)
|
java.lang.Number[] |
getNumbers(java.lang.String key)
|
protected java.util.Map |
getSource()
|
java.lang.String |
getString(java.lang.String key)
|
java.lang.String |
getString(java.lang.String key,
java.lang.String alternate)
|
java.lang.String[] |
getStrings(java.lang.String key)
|
java.lang.Object |
getValue(java.lang.String key)
|
java.lang.Object[] |
getValues(java.lang.String key)
|
protected void |
setSource(java.util.Map source)
|
Methods inherited from class org.apache.velocity.tools.generic.ConversionTool |
configure, getDateFormat, getNumberFormat, getStringsDelimiter, parseBoolean, parseDate, parseDate, parseDate, parseDate, parseDate, parseLocale, parseNumber, parseNumber, parseNumber, parseNumber, parseStringList, setDateFormat, setNumberFormat, setStringsDelimiter, toBoolean, toBooleans, toBooleans, toCalendar, toCalendars, toCalendars, toDate, toDates, toDates, toDouble, toDoubles, toInteger, toInts, toLocale, toLocales, toLocales, toNumber, toNumbers, toNumbers, toString, toString, toStrings |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
source
private java.util.Map source
ValueParser
public ValueParser()
ValueParser
public ValueParser(java.util.Map source)
setSource
protected void setSource(java.util.Map source)
getSource
protected java.util.Map getSource()
exists
public boolean exists(java.lang.String key)
- Convenience method for checking whether a certain parameter exists.
- Parameters:
key
- the parameter's key
- Returns:
true
if a parameter exists for the specified
key; otherwise, returns false
.
get
public java.lang.Object get(java.lang.String key)
- Convenience method for use in Velocity templates.
This allows for easy "dot" access to parameters.
e.g. $params.foo instead of $params.getString('foo')
- Parameters:
key
- the parameter's key
- Returns:
- parameter matching the specified key or
null
if there is no matching
parameter
getValue
public java.lang.Object getValue(java.lang.String key)
getValues
public java.lang.Object[] getValues(java.lang.String key)
getString
public java.lang.String getString(java.lang.String key)
- Parameters:
key
- the parameter's key
- Returns:
- parameter matching the specified key or
null
if there is no matching
parameter
getString
public java.lang.String getString(java.lang.String key,
java.lang.String alternate)
- Parameters:
key
- the desired parameter's keyalternate
- The alternate value
- Returns:
- parameter matching the specified key or the
specified alternate String if there is no matching
parameter
getBoolean
public java.lang.Boolean getBoolean(java.lang.String key)
- Parameters:
key
- the desired parameter's key
- Returns:
- a
Boolean
object for the specified key or
null
if no matching parameter is found
getBoolean
public boolean getBoolean(java.lang.String key,
boolean alternate)
- Parameters:
key
- the desired parameter's keyalternate
- The alternate boolean value
- Returns:
- boolean value for the specified key or the
alternate boolean is no value is found
getBoolean
public java.lang.Boolean getBoolean(java.lang.String key,
java.lang.Boolean alternate)
- Parameters:
key
- the desired parameter's keyalternate
- the alternate Boolean
- Returns:
- a
Boolean
for the specified key or the specified
alternate if no matching parameter is found
getInteger
public java.lang.Integer getInteger(java.lang.String key)
- Parameters:
key
- the desired parameter's key
- Returns:
- a
Integer
for the specified key or
null
if no matching parameter is found
getInteger
public java.lang.Integer getInteger(java.lang.String key,
java.lang.Integer alternate)
- Parameters:
key
- the desired parameter's keyalternate
- The alternate Integer
- Returns:
- an Integer for the specified key or the specified
alternate if no matching parameter is found
getDouble
public java.lang.Double getDouble(java.lang.String key)
- Parameters:
key
- the desired parameter's key
- Returns:
- a
Double
for the specified key or
null
if no matching parameter is found
getDouble
public java.lang.Double getDouble(java.lang.String key,
java.lang.Double alternate)
- Parameters:
key
- the desired parameter's keyalternate
- The alternate Double
- Returns:
- an Double for the specified key or the specified
alternate if no matching parameter is found
getNumber
public java.lang.Number getNumber(java.lang.String key)
- Parameters:
key
- the desired parameter's key
- Returns:
- a
Number
for the specified key or
null
if no matching parameter is found
getLocale
public java.util.Locale getLocale(java.lang.String key)
- Parameters:
key
- the desired parameter's key
- Returns:
- a
Locale
for the specified key or
null
if no matching parameter is found
getNumber
public java.lang.Number getNumber(java.lang.String key,
java.lang.Number alternate)
- Parameters:
key
- the desired parameter's keyalternate
- The alternate Number
- Returns:
- a Number for the specified key or the specified
alternate if no matching parameter is found
getInt
public int getInt(java.lang.String key,
int alternate)
- Parameters:
key
- the desired parameter's keyalternate
- The alternate int value
- Returns:
- the int value for the specified key or the specified
alternate value if no matching parameter is found
getDouble
public double getDouble(java.lang.String key,
double alternate)
- Parameters:
key
- the desired parameter's keyalternate
- The alternate double value
- Returns:
- the double value for the specified key or the specified
alternate value if no matching parameter is found
getLocale
public java.util.Locale getLocale(java.lang.String key,
java.util.Locale alternate)
- Parameters:
key
- the desired parameter's keyalternate
- The alternate Locale
- Returns:
- a Locale for the specified key or the specified
alternate if no matching parameter is found
getStrings
public java.lang.String[] getStrings(java.lang.String key)
- Parameters:
key
- the key for the desired parameter
- Returns:
- an array of String objects containing all of the values
associated with the given key, or
null
if the no values are associated with the given key
getBooleans
public java.lang.Boolean[] getBooleans(java.lang.String key)
- Parameters:
key
- the key for the desired parameter
- Returns:
- an array of Boolean objects associated with the given key.
getNumbers
public java.lang.Number[] getNumbers(java.lang.String key)
- Parameters:
key
- the key for the desired parameter
- Returns:
- an array of Number objects associated with the given key,
or
null
if Numbers are not associated with it.
getInts
public int[] getInts(java.lang.String key)
- Parameters:
key
- the key for the desired parameter
- Returns:
- an array of int values associated with the given key,
or
null
if numbers are not associated with it.
getDoubles
public double[] getDoubles(java.lang.String key)
- Parameters:
key
- the key for the desired parameter
- Returns:
- an array of double values associated with the given key,
or
null
if numbers are not associated with it.
getLocales
public java.util.Locale[] getLocales(java.lang.String key)
- Parameters:
key
- the key for the desired parameter
- Returns:
- an array of Locale objects associated with the given key,
or
null
if Locales are not associated with it.
Copyright (c) 2003-2007 Apache Software Foundation