java.lang.Object | ||
↳ | org.apache.http.params.AbstractHttpParams | |
↳ | org.apache.http.impl.client.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.
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
applicationParams | The application parameter collection, or null . |
||||||||||
clientParams | The client parameter collection, or null . |
||||||||||
overrideParams | The override parameter collection, or null . |
||||||||||
requestParams | The request parameter collection, or null . |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a new parameter stack from elements.
| |||||||||||
Creates a copy of a parameter stack.
| |||||||||||
Creates a modified copy of a parameter stack.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Does not copy parameters.
| |||||||||||
Obtains the application parameters of this stack.
| |||||||||||
Obtains the client parameters of this stack.
| |||||||||||
Obtains the override parameters of this stack.
| |||||||||||
Obtains a parameter from this stack.
| |||||||||||
Obtains the request parameters of this stack.
| |||||||||||
Does not remove a parameter.
| |||||||||||
Does not set a parameter.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.http.params.AbstractHttpParams
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
org.apache.http.params.HttpParams
|
The application parameter collection, or null
.
The client parameter collection, or null
.
The override parameter collection, or null
.
The request parameter collection, or null
.
Creates a new parameter stack from elements. The arguments will be stored as-is, there is no copying to prevent modification.
aparams | application parameters, or null |
---|---|
cparams | client parameters, or null |
rparams | request parameters, or null |
oparams | override parameters, or null
|
Creates a copy of a parameter stack. The new stack will have the exact same entries as the argument stack. There is no copying of parameters.
stack | the stack to copy |
---|
Creates a modified copy of a parameter stack.
The new stack will contain the explicitly passed elements.
For elements where the explicit argument is null
,
the corresponding element from the argument stack is used.
There is no copying of parameters.
stack | the stack to modify |
---|---|
aparams | application parameters, or null |
cparams | client parameters, or null |
rparams | request parameters, or null |
oparams | override parameters, or null
|
Does not copy parameters.
Parameter stacks are lightweight objects, expected to be instantiated
as needed and to be used only in a very specific context. On top of
that, they are read-only. The typical copy operation to prevent
accidental modification of parameters passed by the application to
a framework object is therefore pointless and disabled.
Create a new stack if you really need a copy.
Derived classes may change this behavior.
this
parameter stack
Obtains the application parameters of this stack.
null
Obtains the client parameters of this stack.
null
Obtains the override parameters of this stack.
null
Obtains a parameter from this stack. See class comment for search order.
name | the name of the parameter to obtain |
---|
null
if it is not set anywhere in this stack
Obtains the request parameters of this stack.
null
Does not remove a parameter. Parameter stacks are read-only. It is possible, though discouraged, to access and modify specific stack entries. Derived classes may change this behavior.
name | ignored |
---|
UnsupportedOperationException | always |
---|
Does not set a parameter. Parameter stacks are read-only. It is possible, though discouraged, to access and modify specific stack entries. Derived classes may change this behavior.
name | ignored |
---|---|
value | ignored |
UnsupportedOperationException | always |
---|