| org.apache.turbine.util.parser.BaseValueParser
 org.apache.turbine.util.parser.DefaultParameterParser
| DefaultParameterParser | | public class DefaultParameterParser extends BaseValueParser implements ParameterParser,Recyclable(Code) | | DefaultParameterParser is a utility object to handle parsing and
retrieving the data passed via the GET/POST/PATH_INFO arguments.
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:
ParameterParser pp = data.getParameters();
pp.add("ERROR",1);
pp.add("eRrOr",2);
int result = pp.getInt("ERROR");
In the above example, result is 2.
author:
Ilkka Priha
author:
Jon S. Stevens
author:
Sean Legassick
author:
Henning P. Schmiedehausen
version:
$Id: DefaultParameterParser.java 534527 2007-05-02 16:10:59Z tv $ |
| DefaultParameterParser | | public DefaultParameterParser()(Code) | | Create a new empty instance of ParameterParser. Uses the
default character encoding (US-ASCII).
To add name/value pairs to this set of parameters, use the
add() methods.
|
| DefaultParameterParser | | public DefaultParameterParser(String characterEncoding)(Code) | | Create a new empty instance of ParameterParser. Takes a
character encoding name to use when converting strings to
bytes.
To add name/value pairs to this set of parameters, use the
add() methods.
Parameters:
characterEncoding - The character encoding of strings. |
| add | | public void add(String name, FileItem item)(Code) | | Add a FileItem object as a parameters. If there are any
FileItems already associated with the name, append to the
array. The reason for this is that RFC 1867 allows multiple
files to be associated with single HTML input element.
Parameters:
name - A String with the name.
Parameters:
value - A FileItem with the value. |
| append | | public void append(String name, FileItem item)(Code) | | Add a FileItem object as a parameters. If there are any
FileItems already associated with the name, append to the
array. The reason for this is that RFC 1867 allows multiple
files to be associated with single HTML input element.
Parameters:
name - A String with the name.
Parameters:
value - A FileItem with the value. |
| containsKey | | public boolean containsKey(Object key)(Code) | | Determine whether a given key has been inserted. All keys are
stored in lowercase strings, so override method to account for
this.
Parameters:
key - An Object with the key to search for. True if the object is found. |
| dispose | | public void dispose()(Code) | | Disposes the parser.
|
| getFileItem | | public FileItem getFileItem(String name)(Code) | | Return a FileItem object for the given name. If the name does
not exist or the object stored is not a FileItem, return null.
Parameters:
name - A String with the name. A FileItem. |
| getFileItemParam | | protected FileItem[] getFileItemParam(String name)(Code) | | fetches a key from the parameters map. Makes sure that the name is
always mapped correctly.
Parameters:
name - A string with the name the value object array or null if not set |
| getFileItems | | public FileItem[] getFileItems(String name)(Code) | | Return an array of FileItem objects for the given name. If the
name does not exist, return null.
Parameters:
name - A String with the name. An Array of FileItems or null. |
| getRequest | | public HttpServletRequest getRequest()(Code) | | Gets the parsed servlet request.
the parsed servlet request or null. |
| getToStringParam | | protected Object[] getToStringParam(String name)(Code) | | This method is only used in toString() and can be used by
derived classes to add their local parameters to the toString()
Parameters:
name - A string with the name the value object array or null if not set |
| getUploadData | | public byte[] getUploadData()(Code) | | Gets the uploadData byte[]
uploadData A byte[] with data. |
| keySet | | public Set keySet()(Code) | | Gets the set of keys (FileItems and regular parameters)
A Set of the keys. |
| putFileItemParam | | protected void putFileItemParam(String name, FileItem[] value)(Code) | | Puts a key into the parameters map. Makes sure that the name is always
mapped correctly. This method also enforces the usage of arrays for the
parameters.
Parameters:
name - A String with the name.
Parameters:
value - An array of Objects with the values. |
| setRequest | | public void setRequest(HttpServletRequest request)(Code) | | Sets the servlet request to the parser. This requires a
valid HttpServletRequest object. It will attempt to parse out
the GET/POST/PATH_INFO data and store the data into a Map.
There are convenience methods for retrieving the data as a
number of different datatypes. The PATH_INFO data must be a
URLEncoded() string.
To add name/value pairs to this set of parameters, use the
add() methods.
Parameters:
request - An HttpServletRequest. |
| setUploadData | | public void setUploadData(byte[] uploadData)(Code) | | Sets the uploadData byte[]
Parameters:
uploadData - A byte[] with data. |
| Methods inherited from org.apache.turbine.util.parser.BaseValueParser | public void add(String name, double value)(Code)(Java Doc)
public void add(String name, int value)(Code)(Java Doc)
public void add(String name, Integer value)(Code)(Java Doc)
public void add(String name, long value)(Code)(Java Doc)
public void add(String name, String value)(Code)(Java Doc)
public void add(String name, String[] value)(Code)(Java Doc)
public void append(String name, String value)(Code)(Java Doc)
public void clear()(Code)(Java Doc)
public boolean containsDateSelectorKeys(String key)(Code)(Java Doc)
public boolean containsKey(Object key)(Code)(Java Doc)
public boolean containsTimeSelectorKeys(String key)(Code)(Java Doc)
public String convert(String value)(Code)(Java Doc)
public static String convertAndTrim(String value)(Code)(Java Doc)
public void dispose()(Code)(Java Doc)
public String get(String name)(Code)(Java Doc)
public BigDecimal getBigDecimal(String name, BigDecimal defaultValue)(Code)(Java Doc)
public BigDecimal getBigDecimal(String name)(Code)(Java Doc)
public BigDecimal[] getBigDecimals(String name)(Code)(Java Doc)
public Boolean getBool(String name, boolean defaultValue)(Code)(Java Doc)
public Boolean getBool(String name)(Code)(Java Doc)
public boolean getBoolean(String name, boolean defaultValue)(Code)(Java Doc)
public boolean getBoolean(String name)(Code)(Java Doc)
public Boolean getBooleanObject(String name)(Code)(Java Doc)
public Boolean getBooleanObject(String name, Boolean defaultValue)(Code)(Java Doc)
public byte getByte(String name, byte defaultValue)(Code)(Java Doc)
public byte getByte(String name)(Code)(Java Doc)
public Byte getByteObject(String name, Byte defaultValue)(Code)(Java Doc)
public Byte getByteObject(String name)(Code)(Java Doc)
public byte[] getBytes(String name) throws UnsupportedEncodingException(Code)(Java Doc)
public String getCharacterEncoding()(Code)(Java Doc)
public Date getDate(String name, DateFormat df, Date defaultValue)(Code)(Java Doc)
public Date getDate(String name)(Code)(Java Doc)
public Date getDate(String name, DateFormat df)(Code)(Java Doc)
public double getDouble(String name, double defaultValue)(Code)(Java Doc)
public double getDouble(String name)(Code)(Java Doc)
public Double getDoubleObject(String name, Double defaultValue)(Code)(Java Doc)
public Double getDoubleObject(String name)(Code)(Java Doc)
public Double[] getDoubleObjects(String name)(Code)(Java Doc)
public double[] getDoubles(String name)(Code)(Java Doc)
public float getFloat(String name, float defaultValue)(Code)(Java Doc)
public float getFloat(String name)(Code)(Java Doc)
public Float getFloatObject(String name, Float defaultValue)(Code)(Java Doc)
public Float getFloatObject(String name)(Code)(Java Doc)
public Float[] getFloatObjects(String name)(Code)(Java Doc)
public float[] getFloats(String name)(Code)(Java Doc)
public int getInt(String name, int defaultValue)(Code)(Java Doc)
public int getInt(String name)(Code)(Java Doc)
public Integer getIntObject(String name, Integer defaultValue)(Code)(Java Doc)
public Integer getIntObject(String name)(Code)(Java Doc)
public Integer[] getIntObjects(String name)(Code)(Java Doc)
public Integer getInteger(String name, int defaultValue)(Code)(Java Doc)
public Integer getInteger(String name, Integer def)(Code)(Java Doc)
public Integer getInteger(String name)(Code)(Java Doc)
public Integer[] getIntegers(String name)(Code)(Java Doc)
public int[] getInts(String name)(Code)(Java Doc)
public Object[] getKeys()(Code)(Java Doc)
public long getLong(String name, long defaultValue)(Code)(Java Doc)
public long getLong(String name)(Code)(Java Doc)
public Long getLongObject(String name)(Code)(Java Doc)
public Long getLongObject(String name, Long defaultValue)(Code)(Java Doc)
public Long[] getLongObjects(String name)(Code)(Java Doc)
public long[] getLongs(String name)(Code)(Java Doc)
public NumberKey getNumberKey(String name)(Code)(Java Doc)
public Object getObject(String name)(Code)(Java Doc)
public Object[] getObjects(String name)(Code)(Java Doc)
protected String[] getParam(String name)(Code)(Java Doc)
public String getString(String name)(Code)(Java Doc)
public String getString(String name, String defaultValue)(Code)(Java Doc)
public StringKey getStringKey(String name)(Code)(Java Doc)
public String[] getStrings(String name)(Code)(Java Doc)
public String[] getStrings(String name, String[] defaultValue)(Code)(Java Doc)
protected Object[] getToStringParam(String name)(Code)(Java Doc)
public Set keySet()(Code)(Java Doc)
public Enumeration keys()(Code)(Java Doc)
protected void putParam(String name, String[] value)(Code)(Java Doc)
public void recycle(String characterEncoding)(Code)(Java Doc)
public Object remove(String name)(Code)(Java Doc)
public void setCharacterEncoding(String s)(Code)(Java Doc)
public void setProperties(Object bean) throws Exception(Code)(Java Doc)
protected void setProperty(Object bean, PropertyDescriptor prop) throws Exception(Code)(Java Doc)
public void setString(String name, String value)(Code)(Java Doc)
public void setStrings(String name, String[] values)(Code)(Java Doc)
public String toString()(Code)(Java Doc)
|
|
|