Package org.apache.velocity.tools.generic

Class ValueParser

  • All Implemented Interfaces:
    Map<String,​Object>
    Direct Known Subclasses:
    ParameterTool
    @DefaultKey("parser")
public class ValueParser
extends ConversionTool
implements Map<String,​Object>

    Utility class for easy parsing of String values held in a Map.

    This comes in very handy when parsing parameters.

    When subkeys are allowed, getValue("foo") will also search for all keys of the form "foo.bar" and return a ValueParser of the type "bar" -> value for all found values.

    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$ $Date$
    Author:
    Nathan Bubna

    • Field Detail

      • ALLOWSUBKEYS_KEY

        public static final String ALLOWSUBKEYS_KEY
        The key used for specifying whether to support subkeys
        See Also:
        Constant Field Values

      • READONLY_KEY

        public static final String READONLY_KEY
        The key used for specifying whether to be read-only
        See Also:
        Constant Field Values

    • Constructor Detail

      • ValueParser

        public ValueParser()

    • Method Detail

      • getAllowSubkeys

        protected boolean getAllowSubkeys()
        Are subkeys allowed ?
        Returns:
        yes/no

      • setAllowSubkeys

        protected void setAllowSubkeys​(boolean allow)
        allow or disallow subkeys
        Parameters:
        allow -

      • getReadOnly

        protected boolean getReadOnly()
        Is the Map read-only?
        Returns:
        yes/no

      • setReadOnly

        protected void setReadOnly​(boolean ro)
        Set or unset read-only behaviour
        Parameters:
        ro -

      • configure

        protected void configure​(ValueParser values)
        Does the actual configuration. This is protected, so subclasses may share the same ValueParser and call configure at any time, while preventing templates from doing so when configure(Map) is locked.
        Overrides:
        configure in class ConversionTool

      • exists

        public boolean exists​(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 Object get​(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 Object getValue​(String key)
        Returns the value mapped to the specified key in the Map returned by getSource(). If there is no source, then this will always return null.

      • getValue

        public Object getValue​(String key,
                       Object alternate)
        Parameters:
        key - the desired parameter's key
        alternate - The alternate value
        Returns:
        parameter matching the specified key or the specified alternate Object if there is no matching parameter

      • getString

        public String getString​(String key)
        Parameters:
        key - the parameter's key
        Returns:
        parameter matching the specified key or null if there is no matching parameter

      • getString

        public String getString​(String key,
                        String alternate)
        Parameters:
        key - the desired parameter's key
        alternate - The alternate value
        Returns:
        parameter matching the specified key or the specified alternate String if there is no matching parameter

      • getBoolean

        public Boolean getBoolean​(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​(String key,
                          boolean alternate)
        Parameters:
        key - the desired parameter's key
        alternate - The alternate boolean value
        Returns:
        boolean value for the specified key or the alternate boolean is no value is found

      • getBoolean

        public Boolean getBoolean​(String key,
                          Boolean alternate)
        Parameters:
        key - the desired parameter's key
        alternate - the alternate Boolean
        Returns:
        a Boolean for the specified key or the specified alternate if no matching parameter is found

      • getInteger

        public Integer getInteger​(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 Integer getInteger​(String key,
                          Integer alternate)
        Parameters:
        key - the desired parameter's key
        alternate - The alternate Integer
        Returns:
        an Integer for the specified key or the specified alternate if no matching parameter is found

      • getDouble

        public Double getDouble​(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 Double getDouble​(String key,
                        Double alternate)
        Parameters:
        key - the desired parameter's key
        alternate - The alternate Double
        Returns:
        an Double for the specified key or the specified alternate if no matching parameter is found

      • getNumber

        public Number getNumber​(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 Locale getLocale​(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 Number getNumber​(String key,
                        Number alternate)
        Parameters:
        key - the desired parameter's key
        alternate - The alternate Number
        Returns:
        a Number for the specified key or the specified alternate if no matching parameter is found

      • getInt

        public int getInt​(String key,
                  int alternate)
        Parameters:
        key - the desired parameter's key
        alternate - 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​(String key,
                        double alternate)
        Parameters:
        key - the desired parameter's key
        alternate - 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 Locale getLocale​(String key,
                        Locale alternate)
        Parameters:
        key - the desired parameter's key
        alternate - The alternate Locale
        Returns:
        a Locale for the specified key or the specified alternate if no matching parameter is found

      • getStrings

        public String[] getStrings​(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 Boolean[] getBooleans​(String key)
        Parameters:
        key - the key for the desired parameter
        Returns:
        an array of Boolean objects associated with the given key.

      • getNumbers

        public Number[] getNumbers​(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​(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​(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 Locale[] getLocales​(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.

      • hasSubkeys

        public boolean hasSubkeys()
        Determines whether there are subkeys available in the source map.

      • getSubkey

        protected ValueParser getSubkey​(String subkey)
        subkey getter that returns a map -> value for every "subkey.subkey2" found entry
        Parameters:
        subkey - subkey to search for
        Returns:
        the map of found values