Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.commons.httpclient.params.DefaultHttpParams
Constructor Summary | |
| |
|
Method Summary | |
void |
|
Object |
|
boolean |
|
static HttpParams |
|
HttpParams |
|
double |
|
int |
|
long |
|
Object |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
void |
|
void |
|
void |
|
static void |
|
void |
|
void |
|
void |
|
void |
|
public DefaultHttpParams()
Creates a new collection of parameters with the collection returned bygetDefaultParams()
as a parent. The collection will defer to its parent for a default value if a particular parameter is not explicitly set in the collection itself.
- See Also:
getDefaultParams()
public DefaultHttpParams(HttpParams defaults)
Creates a new collection of parameters with the given parent. The collection will defer to its parent for a default value if a particular parameter is not explicitly set in the collection itself.
- Parameters:
defaults
- the parent collection to defer to, if a parameter is not explictly set in the collection itself.
public void clear()
Removes all parameters from this collection.
public Object clone() throws CloneNotSupportedException
Clones this collection of parameters. Please note that paramter values themselves are not cloned.
- See Also:
java.io.Serializable
,java.lang.Object.clone()
public boolean getBooleanParameter(String name, boolean defaultValue)
Returns aBoolean
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.
- Specified by:
- getBooleanParameter in interface HttpParams
- Parameters:
name
- the parent name.defaultValue
- the default value.
- Returns:
- a
Boolean
that represents the value of the parameter.
public static HttpParams getDefaultParams()
Gets the default HttpParams to be used.
- Returns:
- the value returned from
HttpParamsFactory#getDefaultParams()
- See Also:
HttpParamsFactory.getDefaultParams()
public HttpParams getDefaults()
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
- Specified by:
- getDefaults in interface HttpParams
- Returns:
- the parent collection to defer to, if a particular parameter is not explictly set in the collection itself.
- See Also:
HttpParams.setDefaults(HttpParams)
public double getDoubleParameter(String name, double defaultValue)
Returns aDouble
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.
- Specified by:
- getDoubleParameter in interface HttpParams
- Parameters:
name
- the parent name.defaultValue
- the default value.
- Returns:
- a
Double
that represents the value of the parameter.
public int getIntParameter(String name, int defaultValue)
Returns anInteger
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.
- Specified by:
- getIntParameter in interface HttpParams
- Parameters:
name
- the parent name.defaultValue
- the default value.
- Returns:
- a
Integer
that represents the value of the parameter.
public long getLongParameter(String name, long defaultValue)
Returns aLong
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.
- Specified by:
- getLongParameter in interface HttpParams
- Parameters:
name
- the parent name.defaultValue
- the default value.
- Returns:
- a
Long
that represents the value of the parameter.
public Object getParameter(String name)
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.
- Specified by:
- getParameter in interface HttpParams
- Parameters:
name
- the parent name.
- Returns:
- an object that represents the value of the parameter.
public boolean isParameterFalse(String name)
Returns true if the parameter is either not set or is false, false otherwise.
- Specified by:
- isParameterFalse in interface HttpParams
- Parameters:
name
- parameter 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.
- Specified by:
- isParameterSet in interface HttpParams
- Parameters:
name
- parameter 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.
- Specified by:
- isParameterSetLocally in interface HttpParams
- Parameters:
name
- parameter 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.
- Specified by:
- isParameterTrue in interface HttpParams
- Parameters:
name
- parameter name
- Returns:
- true if the parameter is set and is true, false otherwise.
public void setBooleanParameter(String name, boolean value)
Assigns aBoolean
to the parameter with the given name
- Specified by:
- setBooleanParameter in interface HttpParams
- Parameters:
name
- parameter namevalue
- parameter value
public void setDefaults(HttpParams params)
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
- Specified by:
- setDefaults in interface HttpParams
- Parameters:
params
- the parent collection to defer to, if a particular parameter is not explictly set in the collection itself.
- See Also:
HttpParams.getDefaults()
public void setDoubleParameter(String name, double value)
Assigns aDouble
to the parameter with the given name
- Specified by:
- setDoubleParameter in interface HttpParams
- Parameters:
name
- parameter namevalue
- parameter value
public static void setHttpParamsFactory(HttpParamsFactory httpParamsFactory)
Sets the factory that will provide the default HttpParams.
- Parameters:
httpParamsFactory
- an instance of HttpParamsFactory
- See Also:
getDefaultParams()
public void setIntParameter(String name, int value)
Assigns anInteger
to the parameter with the given name
- Specified by:
- setIntParameter in interface HttpParams
- Parameters:
name
- parameter namevalue
- parameter value
public void setLongParameter(String name, long value)
Assigns aLong
to the parameter with the given name
- Specified by:
- setLongParameter in interface HttpParams
- Parameters:
name
- parameter namevalue
- parameter value
public void setParameter(String name, Object value)
Assigns the value to the parameter with the given name
- Specified by:
- setParameter in interface HttpParams
- Parameters:
name
- parameter namevalue
- parameter value
public void setParameters(String[] names, Object value)
Assigns the value to all the parameter with the given names
- Parameters:
names
- array of parameter namevalue
- parameter value