public interface HttpParams
| Modifier and Type | Method and Description |
|---|---|
boolean |
getBooleanParameter(String name,
boolean defaultValue)
Returns a
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(String name,
double defaultValue)
Returns a
Double parameter value with the given name. |
int |
getIntParameter(String name,
int defaultValue)
Returns an
Integer parameter value with the given name. |
long |
getLongParameter(String name,
long defaultValue)
Returns a
Long parameter value with the given name. |
Object |
getParameter(String name)
Returns a parameter value with the given name.
|
boolean |
isParameterFalse(String name)
Returns true if the parameter is either not set or is false,
false otherwise.
|
boolean |
isParameterSet(String name)
Returns true if the parameter is set at any level, false otherwise.
|
boolean |
isParameterSetLocally(String name)
Returns true if the parameter is set locally, false otherwise.
|
boolean |
isParameterTrue(String name)
Returns true if the parameter is set and is true, false
otherwise.
|
void |
setBooleanParameter(String name,
boolean value)
Assigns a
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
|
void |
setDoubleParameter(String name,
double value)
Assigns a
Double to the parameter with the given name |
void |
setIntParameter(String name,
int value)
Assigns an
Integer to the parameter with the given name |
void |
setLongParameter(String name,
long value)
Assigns a
Long to the parameter with the given name |
void |
setParameter(String name,
Object value)
Assigns the value to the parameter with the given name
|
HttpParams getDefaults()
setDefaults(HttpParams)void setDefaults(HttpParams params)
params - the parent collection to defer to, if a particular
parameter is not explictly set in the collection itself.getDefaults()Object getParameter(String name)
name - the parent name.setParameter(String, Object)void setParameter(String name, Object value)
name - parameter namevalue - parameter valuelong getLongParameter(String name, long defaultValue)
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.name - the parent name.defaultValue - the default value.Long that represents the value of the parameter.setLongParameter(String, long)void setLongParameter(String name, long value)
Long to the parameter with the given namename - parameter namevalue - parameter valueint getIntParameter(String name, int defaultValue)
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.name - the parent name.defaultValue - the default value.Integer that represents the value of the parameter.setIntParameter(String, int)void setIntParameter(String name, int value)
Integer to the parameter with the given namename - parameter namevalue - parameter valuedouble getDoubleParameter(String name, double defaultValue)
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.name - the parent name.defaultValue - the default value.Double that represents the value of the parameter.setDoubleParameter(String, double)void setDoubleParameter(String name, double value)
Double to the parameter with the given namename - parameter namevalue - parameter valueboolean getBooleanParameter(String name, boolean defaultValue)
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.name - the parent name.defaultValue - the default value.Boolean that represents the value of the parameter.setBooleanParameter(String, boolean)void setBooleanParameter(String name, boolean value)
Boolean to the parameter with the given namename - parameter namevalue - parameter valueboolean isParameterSet(String name)
name - parameter nameboolean isParameterSetLocally(String name)
name - parameter nameboolean isParameterTrue(String name)
name - parameter nameboolean isParameterFalse(String name)
name - parameter nameCopyright © 2021 Internet2. All rights reserved.