org.apache.commons.httpclient.params
Interface HttpParams
- DefaultHttpParams, HostParams, HttpClientParams, HttpConnectionManagerParams, HttpConnectionParams, HttpMethodParams
public interface HttpParams
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.
boolean | getBooleanParameter(String name, boolean defaultValue) - Returns a
Boolean parameter value with the given name.
|
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
|
double | getDoubleParameter(String name, double defaultValue) - Returns a
Double parameter value with the given name.
|
int | getIntParameter(String name, int defaultValue) - Returns an
Integer parameter value with the given name.
|
long | getLongParameter(String name, long defaultValue) - Returns a
Long parameter value with the given name.
|
Object | getParameter(String name) - Returns a parameter value with the given name.
|
boolean | isParameterFalse(String name) - Returns true if the parameter is either not set or is false,
false otherwise.
|
boolean | isParameterSet(String name) - Returns true if the parameter is set at any level, false otherwise.
|
boolean | isParameterSetLocally(String name) - Returns true if the parameter is set locally, false otherwise.
|
boolean | isParameterTrue(String name) - Returns true if the parameter is set and is true, false
otherwise.
|
void | setBooleanParameter(String name, boolean value) - Assigns a
Boolean to the parameter with the given name
|
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
|
void | setDoubleParameter(String name, double value) - Assigns a
Double to the parameter with the given name
|
void | setIntParameter(String name, int value) - Assigns an
Integer to the parameter with the given name
|
void | setLongParameter(String name, long value) - Assigns a
Long to the parameter with the given name
|
void | setParameter(String name, Object value) - Assigns the value to the parameter with the given name
|
getBooleanParameter
public boolean getBooleanParameter(String name,
boolean defaultValue)
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.
name
- the parent name.defaultValue
- the default value.
- a
Boolean
that represents the value of the parameter.
getDefaults
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
- the parent collection to defer to, if a particular parameter
is not explictly set in the collection itself.
getDoubleParameter
public double getDoubleParameter(String name,
double defaultValue)
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.
name
- the parent name.defaultValue
- the default value.
- a
Double
that represents the value of the parameter.
getIntParameter
public int getIntParameter(String name,
int defaultValue)
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.
name
- the parent name.defaultValue
- the default value.
- a
Integer
that represents the value of the parameter.
getLongParameter
public long getLongParameter(String name,
long defaultValue)
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.
name
- the parent name.defaultValue
- the default value.
- a
Long
that represents the value of the parameter.
getParameter
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.
- an object that represents the value of the parameter.
isParameterFalse
public boolean isParameterFalse(String name)
Returns true if the parameter is either not set or is false,
false otherwise.
- true if the parameter is either not set or is false,
false otherwise.
isParameterSet
public boolean isParameterSet(String name)
Returns true if the parameter is set at any level, false otherwise.
- true if the parameter is set at any level, false
otherwise.
isParameterSetLocally
public boolean isParameterSetLocally(String name)
Returns true if the parameter is set locally, false otherwise.
- true if the parameter is set locally, false
otherwise.
isParameterTrue
public boolean isParameterTrue(String name)
Returns true if the parameter is set and is true, false
otherwise.
- true if the parameter is set and is true, false
otherwise.
setBooleanParameter
public void setBooleanParameter(String name,
boolean value)
Assigns a Boolean
to the parameter with the given name
name
- parameter namevalue
- parameter value
setDefaults
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
params
- the parent collection to defer to, if a particular
parameter is not explictly set in the collection itself.
setDoubleParameter
public void setDoubleParameter(String name,
double value)
Assigns a Double
to the parameter with the given name
name
- parameter namevalue
- parameter value
setIntParameter
public void setIntParameter(String name,
int value)
Assigns an Integer
to the parameter with the given name
name
- parameter namevalue
- parameter value
setLongParameter
public void setLongParameter(String name,
long value)
Assigns a Long
to the parameter with the given name
name
- parameter namevalue
- parameter value
setParameter
public void setParameter(String name,
Object value)
Assigns the value to the parameter with the given name
name
- parameter namevalue
- parameter value
Copyright (c) 1999-2005 - Apache Software Foundation