org.apache.http.params
Interface HttpParams

All Known Subinterfaces:
HttpLinkedParams
All Known Implementing Classes:
AbstractHttpParams, BasicHttpParams

public interface HttpParams

Represents a collection of HTTP protocol and framework parameters.

Since:
4.0
Version:
$Revision: 542224 $
Author:
Oleg Kalnichevski

Method Summary
 HttpParams copy()
          Creates a copy of these parameters.
 boolean getBooleanParameter(java.lang.String name, boolean defaultValue)
          Returns a Boolean parameter value with the given name.
 double getDoubleParameter(java.lang.String name, double defaultValue)
          Returns a Double parameter value with the given name.
 int getIntParameter(java.lang.String name, int defaultValue)
          Returns an Integer parameter value with the given name.
 long getLongParameter(java.lang.String name, long defaultValue)
          Returns a Long parameter value with the given name.
 java.lang.Object getParameter(java.lang.String name)
          Returns a parameter value with the given name.
 boolean isParameterFalse(java.lang.String name)
          Returns true if the parameter is either not set or is false, false otherwise.
 boolean isParameterSet(java.lang.String name)
          Returns true if the parameter is set at any level, false otherwise.
 boolean isParameterTrue(java.lang.String name)
          Returns true if the parameter is set and is true, false otherwise.
 HttpParams setBooleanParameter(java.lang.String name, boolean value)
          Assigns a Boolean to the parameter with the given name
 HttpParams setDoubleParameter(java.lang.String name, double value)
          Assigns a Double to the parameter with the given name
 HttpParams setIntParameter(java.lang.String name, int value)
          Assigns an Integer to the parameter with the given name
 HttpParams setLongParameter(java.lang.String name, long value)
          Assigns a Long to the parameter with the given name
 HttpParams setParameter(java.lang.String name, java.lang.Object value)
          Assigns the value to the parameter with the given name
 

Method Detail

getParameter

java.lang.Object getParameter(java.lang.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:
setParameter(String, Object)

setParameter

HttpParams setParameter(java.lang.String name,
                        java.lang.Object value)
Assigns the value to the parameter with the given name

Parameters:
name - parameter name
value - parameter value

copy

HttpParams copy()
Creates a copy of these parameters.

Returns:
a new set of parameters holding the same values as this one

getLongParameter

long getLongParameter(java.lang.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.

Parameters:
name - the parent name.
defaultValue - the default value.
Returns:
a Long that represents the value of the parameter.
See Also:
setLongParameter(String, long)

setLongParameter

HttpParams setLongParameter(java.lang.String name,
                            long value)
Assigns a Long to the parameter with the given name

Parameters:
name - parameter name
value - parameter value

getIntParameter

int getIntParameter(java.lang.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.

Parameters:
name - the parent name.
defaultValue - the default value.
Returns:
a Integer that represents the value of the parameter.
See Also:
setIntParameter(String, int)

setIntParameter

HttpParams setIntParameter(java.lang.String name,
                           int value)
Assigns an Integer to the parameter with the given name

Parameters:
name - parameter name
value - parameter value

getDoubleParameter

double getDoubleParameter(java.lang.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.

Parameters:
name - the parent name.
defaultValue - the default value.
Returns:
a Double that represents the value of the parameter.
See Also:
setDoubleParameter(String, double)

setDoubleParameter

HttpParams setDoubleParameter(java.lang.String name,
                              double value)
Assigns a Double to the parameter with the given name

Parameters:
name - parameter name
value - parameter value

getBooleanParameter

boolean getBooleanParameter(java.lang.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.

Parameters:
name - the parent name.
defaultValue - the default value.
Returns:
a Boolean that represents the value of the parameter.
See Also:
setBooleanParameter(String, boolean)

setBooleanParameter

HttpParams setBooleanParameter(java.lang.String name,
                               boolean value)
Assigns a Boolean to the parameter with the given name

Parameters:
name - parameter name
value - parameter value

isParameterSet

boolean isParameterSet(java.lang.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.

isParameterTrue

boolean isParameterTrue(java.lang.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.

isParameterFalse

boolean isParameterFalse(java.lang.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.


Copyright © 2005-2009 Apache Software Foundation. All Rights Reserved.