|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.http.params.AbstractHttpParams
org.apache.http.impl.client.ClientParamsStack
@NotThreadSafe public class ClientParamsStack
Represents a stack of parameter collections. When retrieving a parameter, the stack is searched in a fixed order and the first match returned. Setting parameters via the stack is not supported. To minimize overhead, the stack has a fixed size and does not maintain an internal array. The supported stack entries, sorted by increasing priority, are:
HttpClient.
These provide client specific defaults.
HttpClient.
These can be used to set parameters that cannot be overridden
on a per-request basis.
null. That is preferable over
an empty params collection, since it avoids searching the empty collection
when looking up parameters.
| Field Summary | |
|---|---|
protected HttpParams |
applicationParams
The application parameter collection, or null. |
protected HttpParams |
clientParams
The client parameter collection, or null. |
protected HttpParams |
overrideParams
The override parameter collection, or null. |
protected HttpParams |
requestParams
The request parameter collection, or null. |
| Constructor Summary | |
|---|---|
ClientParamsStack(ClientParamsStack stack)
Creates a copy of a parameter stack. |
|
ClientParamsStack(ClientParamsStack stack,
HttpParams aparams,
HttpParams cparams,
HttpParams rparams,
HttpParams oparams)
Creates a modified copy of a parameter stack. |
|
ClientParamsStack(HttpParams aparams,
HttpParams cparams,
HttpParams rparams,
HttpParams oparams)
Creates a new parameter stack from elements. |
|
| Method Summary | |
|---|---|
HttpParams |
copy()
Does not copy parameters. |
HttpParams |
getApplicationParams()
Obtains the application parameters of this stack. |
HttpParams |
getClientParams()
Obtains the client parameters of this stack. |
HttpParams |
getOverrideParams()
Obtains the override parameters of this stack. |
Object |
getParameter(String name)
Obtains a parameter from this stack. |
HttpParams |
getRequestParams()
Obtains the request parameters of this stack. |
boolean |
removeParameter(String name)
Does not remove a parameter. |
HttpParams |
setParameter(String name,
Object value)
Does not set a parameter. |
| Methods inherited from class org.apache.http.params.AbstractHttpParams |
|---|
getBooleanParameter, getDoubleParameter, getIntParameter, getLongParameter, getNames, isParameterFalse, isParameterTrue, setBooleanParameter, setDoubleParameter, setIntParameter, setLongParameter |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected final HttpParams applicationParams
null.
protected final HttpParams clientParams
null.
protected final HttpParams requestParams
null.
protected final HttpParams overrideParams
null.
| Constructor Detail |
|---|
public ClientParamsStack(HttpParams aparams,
HttpParams cparams,
HttpParams rparams,
HttpParams oparams)
aparams - application parameters, or nullcparams - client parameters, or nullrparams - request parameters, or nulloparams - override parameters, or nullpublic ClientParamsStack(ClientParamsStack stack)
stack - the stack to copy
public ClientParamsStack(ClientParamsStack stack,
HttpParams aparams,
HttpParams cparams,
HttpParams rparams,
HttpParams oparams)
null,
the corresponding element from the argument stack is used.
There is no copying of parameters.
stack - the stack to modifyaparams - application parameters, or nullcparams - client parameters, or nullrparams - request parameters, or nulloparams - override parameters, or null| Method Detail |
|---|
public final HttpParams getApplicationParams()
nullpublic final HttpParams getClientParams()
nullpublic final HttpParams getRequestParams()
nullpublic final HttpParams getOverrideParams()
nullpublic Object getParameter(String name)
name - the name of the parameter to obtain
null if it is not set anywhere in this stack
public HttpParams setParameter(String name,
Object value)
throws UnsupportedOperationException
name - ignoredvalue - ignored
UnsupportedOperationException - alwayspublic boolean removeParameter(String name)
name - ignored
UnsupportedOperationException - alwayspublic HttpParams copy()
this parameter stack
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||