Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> apache >> http >> [ impl overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.apache.http.impl.DefaultHttpParams JAVADOC | Sourc code of org.apache.http.impl.DefaultHttpParams SOURCE | Download org.apache.http.impl.DefaultHttpParams DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.http.impl
Class DefaultHttpParams  view DefaultHttpParams download DefaultHttpParams.java

java.lang.Object
  extended byorg.apache.http.impl.DefaultHttpParams
All Implemented Interfaces:
org.apache.http.params.HttpParams, java.io.Serializable
public class DefaultHttpParams
extends java.lang.Object
implements org.apache.http.params.HttpParams, java.io.Serializable

This class 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: 390703 $

Field Summary
private  org.apache.http.params.HttpParams defaults
          The set of default values to defer to
private  java.util.HashMap parameters
          Hash map of HTTP parameters that this collection contains
(package private) static long serialVersionUID
           
 
Constructor Summary
DefaultHttpParams()
           
DefaultHttpParams(org.apache.http.params.HttpParams defaults)
          Creates a new collection of parameters with the given parent.
 
Method Summary
 void clear()
          Removes all parameters from this collection.
 boolean getBooleanParameter(java.lang.String name, boolean defaultValue)
          Returns a java.lang.Boolean parameter value with the given name.
 org.apache.http.params.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(java.lang.String name, double defaultValue)
          Returns a java.lang.Double parameter value with the given name.
 int getIntParameter(java.lang.String name, int defaultValue)
          Returns an java.lang.Integer parameter value with the given name.
 long getLongParameter(java.lang.String name, long defaultValue)
          Returns a java.lang.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 isParameterSetLocally(java.lang.String name)
          Returns true if the parameter is set locally, false otherwise.
 boolean isParameterTrue(java.lang.String name)
          Returns true if the parameter is set and is true, false otherwise.
 org.apache.http.params.HttpParams setBooleanParameter(java.lang.String name, boolean value)
          Assigns a java.lang.Boolean to the parameter with the given name
 void setDefaults(org.apache.http.params.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
 org.apache.http.params.HttpParams setDoubleParameter(java.lang.String name, double value)
          Assigns a java.lang.Double to the parameter with the given name
 org.apache.http.params.HttpParams setIntParameter(java.lang.String name, int value)
          Assigns an java.lang.Integer to the parameter with the given name
 org.apache.http.params.HttpParams setLongParameter(java.lang.String name, long value)
          Assigns a java.lang.Long to the parameter with the given name
 org.apache.http.params.HttpParams setParameter(java.lang.String name, java.lang.Object value)
          Assigns the value to the parameter with the given name
 void setParameters(java.lang.String[] names, java.lang.Object value)
          Assigns the value to all the parameter with the given names
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values

defaults

private org.apache.http.params.HttpParams defaults
The set of default values to defer to

parameters

private java.util.HashMap parameters
Hash map of HTTP parameters that this collection contains

Constructor Detail

DefaultHttpParams

public DefaultHttpParams(org.apache.http.params.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.

DefaultHttpParams

public DefaultHttpParams()
Method Detail

getDefaults

public org.apache.http.params.HttpParams getDefaults()
Description copied from interface: org.apache.http.params.HttpParams
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 org.apache.http.params.HttpParams

setDefaults

public void setDefaults(org.apache.http.params.HttpParams params)
Description copied from interface: org.apache.http.params.HttpParams
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 org.apache.http.params.HttpParams

getParameter

public java.lang.Object getParameter(java.lang.String name)
Description copied from interface: org.apache.http.params.HttpParams
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 org.apache.http.params.HttpParams

setParameter

public org.apache.http.params.HttpParams setParameter(java.lang.String name,
                                                      java.lang.Object value)
Description copied from interface: org.apache.http.params.HttpParams
Assigns the value to the parameter with the given name

Specified by:
setParameter in interface org.apache.http.params.HttpParams

setParameters

public void setParameters(java.lang.String[] names,
                          java.lang.Object value)
Assigns the value to all the parameter with the given names

getLongParameter

public long getLongParameter(java.lang.String name,
                             long defaultValue)
Description copied from interface: org.apache.http.params.HttpParams
Returns a java.lang.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.

Specified by:
getLongParameter in interface org.apache.http.params.HttpParams

setLongParameter

public org.apache.http.params.HttpParams setLongParameter(java.lang.String name,
                                                          long value)
Description copied from interface: org.apache.http.params.HttpParams
Assigns a java.lang.Long to the parameter with the given name

Specified by:
setLongParameter in interface org.apache.http.params.HttpParams

getIntParameter

public int getIntParameter(java.lang.String name,
                           int defaultValue)
Description copied from interface: org.apache.http.params.HttpParams
Returns an java.lang.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.

Specified by:
getIntParameter in interface org.apache.http.params.HttpParams

setIntParameter

public org.apache.http.params.HttpParams setIntParameter(java.lang.String name,
                                                         int value)
Description copied from interface: org.apache.http.params.HttpParams
Assigns an java.lang.Integer to the parameter with the given name

Specified by:
setIntParameter in interface org.apache.http.params.HttpParams

getDoubleParameter

public double getDoubleParameter(java.lang.String name,
                                 double defaultValue)
Description copied from interface: org.apache.http.params.HttpParams
Returns a java.lang.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.

Specified by:
getDoubleParameter in interface org.apache.http.params.HttpParams

setDoubleParameter

public org.apache.http.params.HttpParams setDoubleParameter(java.lang.String name,
                                                            double value)
Description copied from interface: org.apache.http.params.HttpParams
Assigns a java.lang.Double to the parameter with the given name

Specified by:
setDoubleParameter in interface org.apache.http.params.HttpParams

getBooleanParameter

public boolean getBooleanParameter(java.lang.String name,
                                   boolean defaultValue)
Description copied from interface: org.apache.http.params.HttpParams
Returns a java.lang.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.

Specified by:
getBooleanParameter in interface org.apache.http.params.HttpParams

setBooleanParameter

public org.apache.http.params.HttpParams setBooleanParameter(java.lang.String name,
                                                             boolean value)
Description copied from interface: org.apache.http.params.HttpParams
Assigns a java.lang.Boolean to the parameter with the given name

Specified by:
setBooleanParameter in interface org.apache.http.params.HttpParams

isParameterSet

public boolean isParameterSet(java.lang.String name)
Description copied from interface: org.apache.http.params.HttpParams
Returns true if the parameter is set at any level, false otherwise.

Specified by:
isParameterSet in interface org.apache.http.params.HttpParams

isParameterSetLocally

public boolean isParameterSetLocally(java.lang.String name)
Description copied from interface: org.apache.http.params.HttpParams
Returns true if the parameter is set locally, false otherwise.

Specified by:
isParameterSetLocally in interface org.apache.http.params.HttpParams

isParameterTrue

public boolean isParameterTrue(java.lang.String name)
Description copied from interface: org.apache.http.params.HttpParams
Returns true if the parameter is set and is true, false otherwise.

Specified by:
isParameterTrue in interface org.apache.http.params.HttpParams

isParameterFalse

public boolean isParameterFalse(java.lang.String name)
Description copied from interface: org.apache.http.params.HttpParams
Returns true if the parameter is either not set or is false, false otherwise.

Specified by:
isParameterFalse in interface org.apache.http.params.HttpParams

clear

public void clear()
Removes all parameters from this collection.

Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> apache >> http >> [ impl overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.apache.http.impl.DefaultHttpParams JAVADOC | Sourc code of org.apache.http.impl.DefaultHttpParams SOURCE | Download org.apache.http.impl.DefaultHttpParams DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD