org.apache.commons.httpclient.params

Interface HttpParams

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.

Since: 3.0

Version: $Revision: 155418 $

Author: Oleg Kalnichevski

Method Summary
booleangetBooleanParameter(String name, boolean defaultValue)
Returns a {@link Boolean} parameter value with the given name.
HttpParamsgetDefaults()
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
doublegetDoubleParameter(String name, double defaultValue)
Returns a {@link Double} parameter value with the given name.
intgetIntParameter(String name, int defaultValue)
Returns an {@link Integer} parameter value with the given name.
longgetLongParameter(String name, long defaultValue)
Returns a {@link Long} parameter value with the given name.
ObjectgetParameter(String name)
Returns a parameter value with the given name.
booleanisParameterFalse(String name)
Returns true if the parameter is either not set or is false, false otherwise.
booleanisParameterSet(String name)
Returns true if the parameter is set at any level, false otherwise.
booleanisParameterSetLocally(String name)
Returns true if the parameter is set locally, false otherwise.
booleanisParameterTrue(String name)
Returns true if the parameter is set and is true, false otherwise.
voidsetBooleanParameter(String name, boolean value)
Assigns a {@link Boolean} to the parameter with the given name
voidsetDefaults(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
voidsetDoubleParameter(String name, double value)
Assigns a {@link Double} to the parameter with the given name
voidsetIntParameter(String name, int value)
Assigns an {@link Integer} to the parameter with the given name
voidsetLongParameter(String name, long value)
Assigns a {@link Long} to the parameter with the given name
voidsetParameter(String name, Object value)
Assigns the value to the parameter with the given name

Method Detail

getBooleanParameter

public boolean getBooleanParameter(String name, boolean defaultValue)
Returns a {@link 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. defaultValue the default value.

Returns: a {@link Boolean} that represents the value of the parameter.

See Also: HttpParams

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

Returns: the parent collection to defer to, if a particular parameter is not explictly set in the collection itself.

See Also: setDefaults

getDoubleParameter

public double getDoubleParameter(String name, double defaultValue)
Returns a {@link 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. defaultValue the default value.

Returns: a {@link Double} that represents the value of the parameter.

See Also: HttpParams

getIntParameter

public int getIntParameter(String name, int defaultValue)
Returns an {@link 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. defaultValue the default value.

Returns: a {@link Integer} that represents the value of the parameter.

See Also: HttpParams

getLongParameter

public long getLongParameter(String name, long defaultValue)
Returns a {@link 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. defaultValue the default value.

Returns: a {@link Long} that represents the value of the parameter.

See Also: HttpParams

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.

Parameters: name the parent name.

Returns: an object that represents the value of the parameter.

See Also: HttpParams

isParameterFalse

public boolean isParameterFalse(String name)
Returns true if the parameter is either not set or is false, false otherwise.

Parameters: name parameter name

Returns: 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.

Parameters: name parameter name

Returns: 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.

Parameters: name parameter name

Returns: 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.

Parameters: name parameter name

Returns: true if the parameter is set and is true, false otherwise.

setBooleanParameter

public void setBooleanParameter(String name, boolean value)
Assigns a {@link Boolean} to the parameter with the given name

Parameters: name parameter name value 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

Parameters: params the parent collection to defer to, if a particular parameter is not explictly set in the collection itself.

See Also: getDefaults

setDoubleParameter

public void setDoubleParameter(String name, double value)
Assigns a {@link Double} to the parameter with the given name

Parameters: name parameter name value parameter value

setIntParameter

public void setIntParameter(String name, int value)
Assigns an {@link Integer} to the parameter with the given name

Parameters: name parameter name value parameter value

setLongParameter

public void setLongParameter(String name, long value)
Assigns a {@link Long} to the parameter with the given name

Parameters: name parameter name value parameter value

setParameter

public void setParameter(String name, Object value)
Assigns the value to the parameter with the given name

Parameters: name parameter name value parameter value

Copyright (c) 1999-2005 - Apache Software Foundation