IlvServletParameters (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.gantt.servlet.IlvServletParameters

Direct Known Subclasses:

IlvServletConfigParameters, IlvServletContextParameters, IlvServletRequestParameters
```
public abstract class IlvServletParameters
extends Object
```
The IlvServletParameters class represents a read-only collection of parameter name-value string pairs. IlvServletParameters is an abstract base class because it defines useful methods that simplify parameter parsing and handling, but does not define the source of the parameters. Concrete subclasses must connect to the source of the parameters and return them by implementing the getParameterTable() method.
Methods of this class can return parameter values of many basic types (no casting or parsing required), can throw an exception when a parameter is not found (simplifying error handling), and can accept default values (eliminating error handling). It is used like this:
```
 float jpegQuality = params.getFloat("quality", 1.0);
 int width = 0;
 try {
   width = params.getInteger("width");
 }
 catch (NumberFormatException e) {
   handleBadWidth();
 }
 catch (IlvParameterException e) {
   handleNoWidth();
 }
 
```
The IlvServletParameters class uses a delegation model to search for named parameters. Each instance of IlvServletParameters has an optional parent parameters object. When called upon to find a named parameter, an IlvServletParameters instance will first attempt to search itself for the parameter. If it cannot find the named parameter, it will then delegate the search to its parent.
The default charset for input parameters is ISO-8859-1 (Latin-1). If the parameter values are encoded in another format, specify the encoding using setCharacterEncoding() before parsing. The parameter names currently have to be in the Latin-1 character set:
```
 params.setCharacterEncoding("Shift_JIS");
 String japaneseValue = params.getString("latinName");
 
```
This class is based on work done by Jason Hunter as part of the com.oreilly.servlet package.
Since:

JViews 5.0

Constructor Summary

Constructors
Constructor and Description
`IlvServletParameters()` Creates a new `IlvServletParameters` with no parent parameters.
`IlvServletParameters(IlvServletParameters parent)` Creates a new `IlvServletParameters` with the specified set of parent parameters.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getBoolean(String name)` Returns the named parameter value as a boolean, with `true` indicated by "true", "on", or "yes" (in any letter case) and `false` indicated by "false", "off", or "no" (in any letter case).
`boolean`	`getBoolean(String name, boolean def)` Returns the named parameter value as a boolean.
`char`	`getChar(String name)` Returns the named parameter value as a character.
`char`	`getChar(String name, char def)` Returns the named parameter value as a character.
`Date`	`getDate(String name)` Returns the named parameter value as a Date.
`Date`	`getDate(String name, Date def)` Returns the named parameter value as a Date.
`double`	`getDouble(String name)` Returns the named parameter value as a double.
`double`	`getDouble(String name, double def)` Returns the named parameter value as a double.
`float`	`getFloat(String name)` Returns the named parameter value as a float.
`float`	`getFloat(String name, float def)` Returns the named parameter value as a float.
`int`	`getInteger(String name)` Returns the named parameter value as an integer.
`int`	`getInteger(String name, int def)` Returns the named parameter value as an integer.
`long`	`getLong(String name)` Returns the named parameter value as a long.
`long`	`getLong(String name, long def)` Returns the named parameter value as a long.
`protected abstract Hashtable`	`getParameterTable()` Returns the lookup table of parameter name-value string pairs.
`IlvServletParameters`	`getParentParameters()` Returns the parent parameters or `null` if there are none.
`String`	`getString(String name)` Returns the named parameter value as a String.
`String`	`getString(String name, String def)` Returns the named parameter value as a String.
`String`	`getString(String name, String[] validValues, String def)` Returns the named parameter value as a String, which must be one of the specified valid values.
`String[]`	`getStringArray(String name)` Returns the named parameter as an array of String values.
`String[]`	`getStringArray(String name, String delims)` Returns the named parameter as an array of String values.
`void`	`setCharacterEncoding(String encoding)` Sets the character encoding (charset) of the parameters to help the parser properly decode values.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IlvServletParameters
```
public IlvServletParameters()
```
    Creates a new IlvServletParameters with no parent parameters.
  - IlvServletParameters
```
public IlvServletParameters(IlvServletParameters parent)
```
    Creates a new IlvServletParameters with the specified set of parent parameters.
    
    Parameters:
    
    parent - The parent parameters.
- Method Detail
  - getParameterTable
```
protected abstract Hashtable getParameterTable()
```
    Returns the lookup table of parameter name-value string pairs.
  - getParentParameters
```
public IlvServletParameters getParentParameters()
```
    Returns the parent parameters or null if there are none.
  - setCharacterEncoding
```
public void setCharacterEncoding(String encoding)
                          throws UnsupportedEncodingException
```
    Sets the character encoding (charset) of the parameters to help the parser properly decode values. The default is to return undecoded values.
    
    Parameters:
    
    encoding - The charset encoding.
    
    Throws:
    
    UnsupportedEncodingException - if the charset is not supported on this system.
  - getString
```
public String getString(String name)
                 throws IlvParameterException
```
    Returns the named parameter value as a String.
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    The parameter value as a String.
    
    Throws:
    
    IlvParameterException - if the parameter was not found or was the empty string.
  - getString
```
public String getString(String name,
                        String def)
```
    Returns the named parameter value as a String. This method returns the specified default value if the parameter is not found or is the empty string.
    
    Parameters:
    
    name - The parameter name.
    
    def - The default parameter value.
    
    Returns:
    
    The parameter value as a String, or the default.
  - getString
```
public String getString(String name,
                        String[] validValues,
                        String def)
                 throws IlvParameterException
```
    Returns the named parameter value as a String, which must be one of the specified valid values. This method returns the specified default value if the parameter is not found or is the empty string.
    
    Parameters:
    
    name - The parameter name.
    
    validValues - The array of valid parameter values.
    
    def - The default parameter value or null for no default.
    
    Returns:
    
    The parameter value as a String, or the default.
    
    Throws:
    
    IlvParameterException - if the parameter is not one of the specified valid values.
  - getStringArray
```
public String[] getStringArray(String name,
                               String delims)
                        throws IlvParameterException
```
    Returns the named parameter as an array of String values. The characters in the delims argument are the delimiters for separating tokens. Delimiter characters themselves will not be treated as tokens.
    
    Parameters:
    
    name - The parameter name.
    
    delims - The delimiters.
    
    Returns:
    
    The parameter value as an array of delimited Strings.
    
    Throws:
    
    IlvParameterException - if the parameter was not found or was the empty string.
  - getStringArray
```
public String[] getStringArray(String name)
                        throws IlvParameterException
```
    Returns the named parameter as an array of String values. The parameter values are parsed as a sequence of comma-delimited Strings.
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    The parameter value as an array of comma-delimited Strings.
    
    Throws:
    
    IlvParameterException - if the parameter was not found or was the empty string.
  - getBoolean
```
public boolean getBoolean(String name)
                   throws IlvParameterException,
                          NumberFormatException
```
    Returns the named parameter value as a boolean, with true indicated by "true", "on", or "yes" (in any letter case) and false indicated by "false", "off", or "no" (in any letter case).
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    The parameter value as a boolean.
    
    Throws:
    
    IlvParameterException - if the parameter was not found.
    
    NumberFormatException - if the parameter could not be converted to a boolean.
  - getBoolean
```
public boolean getBoolean(String name,
                          boolean def)
```
    Returns the named parameter value as a boolean. This method returns the specified default value if the parameter is not found.
    
    Parameters:
    
    name - The parameter name.
    
    def - the default parameter value.
    
    Returns:
    
    The parameter value as a boolean, or the default.
  - getChar
```
public char getChar(String name)
             throws IlvParameterException
```
    Returns the named parameter value as a character.
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    The parameter value as a character.
    
    Throws:
    
    IlvParameterException - if the parameter was not found or was the empty string.
  - getChar
```
public char getChar(String name,
                    char def)
```
    Returns the named parameter value as a character. This method returns the specified default value if the parameter is not found.
    
    Parameters:
    
    name - The parameter name.
    
    def - The default parameter value.
    
    Returns:
    
    The parameter value as a character, or the default.
  - getDouble
```
public double getDouble(String name)
                 throws IlvParameterException,
                        NumberFormatException
```
    Returns the named parameter value as a double.
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    The parameter value as a double.
    
    Throws:
    
    IlvParameterException - if the parameter was not found.
    
    NumberFormatException - if the parameter could not be converted to a double.
  - getDouble
```
public double getDouble(String name,
                        double def)
```
    Returns the named parameter value as a double. This method returns the specified default value if the parameter is not found.
    
    Parameters:
    
    name - The parameter name.
    
    def - The default parameter value.
    
    Returns:
    
    The parameter value as a double, or the default.
  - getFloat
```
public float getFloat(String name)
               throws IlvParameterException,
                      NumberFormatException
```
    Returns the named parameter value as a float.
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    The parameter value as a float.
    
    Throws:
    
    IlvParameterException - if the parameter was not found.
    
    NumberFormatException - if the parameter could not be converted to a float.
  - getFloat
```
public float getFloat(String name,
                      float def)
```
    Returns the named parameter value as a float. This method returns the specified default value if the parameter is not found.
    
    Parameters:
    
    name - The parameter name.
    
    def - The default parameter value.
    
    Returns:
    
    The parameter value as a float, or the default.
  - getInteger
```
public int getInteger(String name)
               throws IlvParameterException,
                      NumberFormatException
```
    Returns the named parameter value as an integer.
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    The parameter value as an integer.
    
    Throws:
    
    IlvParameterException - if the parameter was not found.
    
    NumberFormatException - if the parameter could not be converted to an integer.
  - getInteger
```
public int getInteger(String name,
                      int def)
```
    Returns the named parameter value as an integer. This method returns the specified default value if the parameter is not found.
    
    Parameters:
    
    name - The parameter name.
    
    def - The default parameter value.
    
    Returns:
    
    The parameter value as an integer, or the default.
  - getLong
```
public long getLong(String name)
             throws IlvParameterException,
                    NumberFormatException
```
    Returns the named parameter value as a long.
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    The parameter value as a long.
    
    Throws:
    
    IlvParameterException - if the parameter was not found.
    
    NumberFormatException - if the parameter could not be converted to a long.
  - getLong
```
public long getLong(String name,
                    long def)
```
    Returns the named parameter value as a long. This method returns the specified default value if the parameter is not found.
    
    Parameters:
    
    name - The parameter name.
    
    def - The default parameter value.
    
    Returns:
    
    The parameter value as a long, or the default.
  - getDate
```
public Date getDate(String name)
             throws IlvParameterException,
                    NumberFormatException
```
    Returns the named parameter value as a Date. The parameter value must be formatted as a comma-delimited list of 3 to 6 integers: yyyy,mm,dd,hh,mm,ss. The first 3 date values are required. If any of the 3 time values are omitted, they default to 0 (midnight). The 6 values correspond to the fields in the java.util.Calendar class:
    - yyyy: The four digit year (for example, 2001).
    - mm: The 0-based month within the year (for example, January=0).
    - dd: The 1-based day within the month.
    - hh: The hour of the day in 24-hour time.
    - mm: The minute of the hour.
    - ss: The second of the minute.
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    The parameter value as a Date.
    
    Throws:
    
    IlvParameterException - if the parameter was not found.
    
    NumberFormatException - if the parameter could not be converted to a Date.
  - getDate
```
public Date getDate(String name,
                    Date def)
```
    Returns the named parameter value as a Date. This method returns the specified default value if the parameter is not found. The parameter value must be formatted as a comma-delimited list of 3 to 6 integers: yyyy,mm,dd,hh,mm,ss. The first 3 date values are required. If any of the 3 time values are omitted, they default to 0 (midnight). The 6 values correspond to the fields in the java.util.Calendar class:
    - yyyy: The four digit year (for example, 2001).
    - mm: The 0-based month within the year (for example, January=0).
    - dd: The 1-based day within the month.
    - hh: The hour of the day in 24-hour time.
    - mm: The minute of the hour.
    - ss: The second of the minute.
    Parameters:
    
    name - The parameter name.
    
    def - The default parameter value.
    
    Returns:
    
    The parameter value as a Date, or the default.

Class IlvServletParameters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IlvServletParameters

IlvServletParameters

Method Detail

getParameterTable

getParentParameters

setCharacterEncoding

getString

getString

getString

getStringArray

getStringArray

getBoolean

getBoolean

getChar

getChar

getDouble

getDouble

getFloat

getFloat

getInteger

getInteger

getLong

getLong

getDate

getDate