Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> http >> [ params overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.http.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: 390703 $

---

Method Summary
boolean	getBooleanParameter(java.lang.String name, boolean defaultValue)           Returns a java.lang.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(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.
HttpParams	setBooleanParameter(java.lang.String name, boolean value)           Assigns a java.lang.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
HttpParams	setDoubleParameter(java.lang.String name, double value)           Assigns a java.lang.Double to the parameter with the given name
HttpParams	setIntParameter(java.lang.String name, int value)           Assigns an java.lang.Integer to the parameter with the given name
HttpParams	setLongParameter(java.lang.String name, long value)           Assigns a java.lang.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

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

---

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

---

getParameter

public 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.

---

setParameter

public HttpParams setParameter(java.lang.String name,
                               java.lang.Object value)

Assigns the value to the parameter with the given name

---

getLongParameter

public long getLongParameter(java.lang.String name,
                             long defaultValue)

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.

---

setLongParameter

public HttpParams setLongParameter(java.lang.String name,
                                   long value)

Assigns a java.lang.Long to the parameter with the given name

---

getIntParameter

public int getIntParameter(java.lang.String name,
                           int defaultValue)

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.

---

setIntParameter

public HttpParams setIntParameter(java.lang.String name,
                                  int value)

Assigns an java.lang.Integer to the parameter with the given name

---

getDoubleParameter

public double getDoubleParameter(java.lang.String name,
                                 double defaultValue)

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.

---

setDoubleParameter

public HttpParams setDoubleParameter(java.lang.String name,
                                     double value)

Assigns a java.lang.Double to the parameter with the given name

---

getBooleanParameter

public boolean getBooleanParameter(java.lang.String name,
                                   boolean defaultValue)

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.

---

setBooleanParameter

public HttpParams setBooleanParameter(java.lang.String name,
                                      boolean value)

Assigns a java.lang.Boolean to the parameter with the given name

---

isParameterSet

public boolean isParameterSet(java.lang.String name)

Returns true if the parameter is set at any level, false otherwise.

---

isParameterSetLocally

public boolean isParameterSetLocally(java.lang.String name)

Returns true if the parameter is set locally, false otherwise.

---

isParameterTrue

public boolean isParameterTrue(java.lang.String name)

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

---

isParameterFalse

public boolean isParameterFalse(java.lang.String name)

Returns true if the parameter is either not set or is false, false otherwise.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> http >> [ params overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---