| org.apache.commons.httpclient.params.HttpParams
All known Subclasses: org.apache.commons.httpclient.params.DefaultHttpParams,
| HttpParams | | public interface HttpParams (Code) | | This interface represents a collection of HTTP protocol parameters. Protocol parameters
may be linked together to form a hierarchy. If a particular parameter value has not been
explicitly defined in the collection itself, its value will be drawn from the parent
collection of parameters.
author:
Oleg Kalnichevski
version:
$Revision: 480424 $
since:
3.0 |
| Method Summary | |
| public boolean | getBooleanParameter(String name, boolean defaultValue)
Returns a
Boolean parameter value with the given name. | | public HttpParams | getDefaults()
| | public double | getDoubleParameter(String name, double defaultValue)
Returns a
Double parameter value with the given name. | | public int | getIntParameter(String name, int defaultValue)
Returns an
Integer parameter value with the given name. | | public long | getLongParameter(String name, long defaultValue)
Returns a
Long parameter value with the given name. | | public Object | getParameter(String name)
Returns a parameter value with the given name. | | public boolean | isParameterFalse(String name)
Returns true if the parameter is either not set or is false,
false otherwise. | | public boolean | isParameterSet(String name)
Returns true if the parameter is set at any level, false otherwise. | | public boolean | isParameterSetLocally(String name)
Returns true if the parameter is set locally, false otherwise. | | public boolean | isParameterTrue(String name)
Returns true if the parameter is set and is true, false
otherwise. | | public void | setBooleanParameter(String name, boolean value)
| | public void | setDefaults(HttpParams params)
| | public void | setDoubleParameter(String name, double value)
| | public void | setIntParameter(String name, int value)
| | public void | setLongParameter(String name, long value)
| | public void | setParameter(String name, Object value)
|
| getBooleanParameter | | public boolean getBooleanParameter(String name, boolean defaultValue)(Code) | | Returns a
Boolean parameter value with the given name.
If the parameter is not explicitly defined in this collection, its
value will be drawn from a higer level collection at which this parameter
is defined. If the parameter is not explicitly set anywhere up the hierarchy,
the default value is returned.
Parameters:
name - the parent name.
Parameters:
defaultValue - the default value. a Boolean that represents the value of the parameter.
See Also: HttpParams.setBooleanParameter(String,boolean) |
| getDefaults | | public HttpParams getDefaults()(Code) | | Returns the parent collection that this collection will defer to
for a default value if a particular parameter is not explicitly
set in the collection itself
the parent collection to defer to, if a particular parameteris not explictly set in the collection itself.
See Also: HttpParams.setDefaults(HttpParams) |
| getDoubleParameter | | public double getDoubleParameter(String name, double defaultValue)(Code) | | Returns a
Double parameter value with the given name.
If the parameter is not explicitly defined in this collection, its
value will be drawn from a higer level collection at which this parameter
is defined. If the parameter is not explicitly set anywhere up the hierarchy,
the default value is returned.
Parameters:
name - the parent name.
Parameters:
defaultValue - the default value. a Double that represents the value of the parameter.
See Also: HttpParams.setDoubleParameter(String,double) |
| getIntParameter | | public int getIntParameter(String name, int defaultValue)(Code) | | Returns an
Integer parameter value with the given name.
If the parameter is not explicitly defined in this collection, its
value will be drawn from a higer level collection at which this parameter
is defined. If the parameter is not explicitly set anywhere up the hierarchy,
the default value is returned.
Parameters:
name - the parent name.
Parameters:
defaultValue - the default value. a Integer that represents the value of the parameter.
See Also: HttpParams.setIntParameter(String,int) |
| getLongParameter | | public long getLongParameter(String name, long defaultValue)(Code) | | Returns a
Long parameter value with the given name.
If the parameter is not explicitly defined in this collection, its
value will be drawn from a higer level collection at which this parameter
is defined. If the parameter is not explicitly set anywhere up the hierarchy,
the default value is returned.
Parameters:
name - the parent name.
Parameters:
defaultValue - the default value. a Long that represents the value of the parameter.
See Also: HttpParams.setLongParameter(String,long) |
| getParameter | | public Object getParameter(String name)(Code) | | Returns a parameter value with the given name. If the parameter is
not explicitly defined in this collection, its value will be drawn
from a higer level collection at which this parameter is defined.
If the parameter is not explicitly set anywhere up the hierarchy,
null value is returned.
Parameters:
name - the parent name. an object that represents the value of the parameter.
See Also: HttpParams.setParameter(String,Object) |
| isParameterFalse | | public boolean isParameterFalse(String name)(Code) | | Returns true if the parameter is either not set or is false,
false otherwise.
Parameters:
name - parameter name true if the parameter is either not set or is false, false otherwise. |
| isParameterSet | | public boolean isParameterSet(String name)(Code) | | Returns true if the parameter is set at any level, false otherwise.
Parameters:
name - parameter name true if the parameter is set at any level, falseotherwise. |
| isParameterSetLocally | | public boolean isParameterSetLocally(String name)(Code) | | Returns true if the parameter is set locally, false otherwise.
Parameters:
name - parameter name true if the parameter is set locally, falseotherwise. |
| isParameterTrue | | public boolean isParameterTrue(String name)(Code) | | Returns true if the parameter is set and is true, false
otherwise.
Parameters:
name - parameter name true if the parameter is set and is true, falseotherwise. |
| setBooleanParameter | | public void setBooleanParameter(String name, boolean value)(Code) | | Assigns a
Boolean to the parameter with the given name
Parameters:
name - parameter name
Parameters:
value - parameter value |
| setDefaults | | public void setDefaults(HttpParams params)(Code) | | Assigns the parent collection that this collection will defer to
for a default value if a particular parameter is not explicitly
set in the collection itself
Parameters:
params - the parent collection to defer to, if a particular parameter is not explictly set in the collection itself.
See Also: HttpParams.getDefaults() |
| setDoubleParameter | | public void setDoubleParameter(String name, double value)(Code) | | Assigns a
Double to the parameter with the given name
Parameters:
name - parameter name
Parameters:
value - parameter value |
| setIntParameter | | public void setIntParameter(String name, int value)(Code) | | Assigns an
Integer to the parameter with the given name
Parameters:
name - parameter name
Parameters:
value - parameter value |
| setLongParameter | | public void setLongParameter(String name, long value)(Code) | | Assigns a
Long to the parameter with the given name
Parameters:
name - parameter name
Parameters:
value - parameter value |
| setParameter | | public void setParameter(String name, Object value)(Code) | | Assigns the value to the parameter with the given name
Parameters:
name - parameter name
Parameters:
value - parameter value |
|
|