ParameterStorage (Cyclos 4.6 Scripting API Documentation)

All Known Implementing Classes:

AbstractParameterStorage, MapParameterStorage
```
public interface ParameterStorage
```
A parameter storage can hold parameters as simple values. Implementations supply a propertyMissing method, so when used in Groovy scripts, it is possible to get / set string parameters with a syntax like parameterStorage.name = "value".

Author:

luis

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`getBoolean(java.lang.String name)` Returns a parameter as a boolean value
`java.math.BigDecimal`	`getDecimal(java.lang.String name)` Returns a parameter as a decimal value, or null if the parameter is not set
`java.util.List<java.math.BigDecimal>`	`getDecimalList(java.lang.String name)` Returns a parameter as a decimal list, or null if the parameter is not set
`<T extends java.lang.Enum<T>> T`	`getEnum(java.lang.String name, java.lang.Class<T> enumType)` Returns a parameter as an enumerated value, with the given class, or null if the parameter is not set
`<T extends java.lang.Enum<T>> java.util.List<T>`	`getEnumList(java.lang.String name, java.lang.Class<T> enumType)` Returns a parameter as a list of enumerated values, with the given class, or null if the parameter is not set
`java.lang.Integer`	`getInteger(java.lang.String name)` Returns a parameter as a integer, or null if the parameter is not set
`java.util.List<java.lang.Integer>`	`getIntegerList(java.lang.String name)` Returns a parameter as a list of integers, or null if the parameter is not set
`java.lang.Long`	`getLong(java.lang.String name)` Returns a parameter as a long, or null if the parameter is not set
`java.util.List<java.lang.Long>`	`getLongList(java.lang.String name)` Returns a parameter as a list of longs, or null if the parameter is not set
`java.util.Iterator<java.lang.String>`	`getNames()` Returns the names of all parameters with values
`java.lang.String`	`getString(java.lang.String name)` Returns the parameter as a string, or null if the parameter is not set
`java.util.List<java.lang.String>`	`getStringList(java.lang.String name)` Returns the parameter as a list of strings, or null if the parameter is not set
`boolean`	`isSet(java.lang.String name)` Returns whether the given parameter is set
`void`	`remove(java.lang.String name)` Removes the parameter with the given name
`void`	`setBoolean(java.lang.String name, boolean value)` Sets the parameter with the given name as a boolean value
`void`	`setDecimal(java.lang.String name, java.math.BigDecimal... values)` Sets the parameter with the given name as a decimal or a list of decimals
`void`	`setEnum(java.lang.String name, java.lang.Enum<?>... values)` Sets the parameter with the given name as an enum or a list of enums
`void`	`setInteger(java.lang.String name, java.lang.Integer... values)` Sets the parameter with the given name as a integer or a list of integer
`void`	`setLong(java.lang.String name, java.lang.Long... values)` Sets the parameter with the given name as a long or a list of long
`void`	`setString(java.lang.String name, java.lang.String... values)` Sets the parameter with the given name as a string or a list of strings

- Method Detail
  - getBoolean
```
boolean getBoolean(java.lang.String name)
```
    Returns a parameter as a boolean value
  - getDecimal
```
java.math.BigDecimal getDecimal(java.lang.String name)
```
    Returns a parameter as a decimal value, or null if the parameter is not set
  - getDecimalList
```
java.util.List<java.math.BigDecimal> getDecimalList(java.lang.String name)
```
    Returns a parameter as a decimal list, or null if the parameter is not set
  - getEnum
```
<T extends java.lang.Enum<T>> T getEnum(java.lang.String name,
                                        java.lang.Class<T> enumType)
```
    Returns a parameter as an enumerated value, with the given class, or null if the parameter is not set
  - getEnumList
```
<T extends java.lang.Enum<T>> java.util.List<T> getEnumList(java.lang.String name,
                                                            java.lang.Class<T> enumType)
```
    Returns a parameter as a list of enumerated values, with the given class, or null if the parameter is not set
  - getInteger
```
java.lang.Integer getInteger(java.lang.String name)
```
    Returns a parameter as a integer, or null if the parameter is not set
  - getIntegerList
```
java.util.List<java.lang.Integer> getIntegerList(java.lang.String name)
```
    Returns a parameter as a list of integers, or null if the parameter is not set
  - getLong
```
java.lang.Long getLong(java.lang.String name)
```
    Returns a parameter as a long, or null if the parameter is not set
  - getLongList
```
java.util.List<java.lang.Long> getLongList(java.lang.String name)
```
    Returns a parameter as a list of longs, or null if the parameter is not set
  - getNames
```
java.util.Iterator<java.lang.String> getNames()
```
    Returns the names of all parameters with values
  - getString
```
java.lang.String getString(java.lang.String name)
```
    Returns the parameter as a string, or null if the parameter is not set
  - getStringList
```
java.util.List<java.lang.String> getStringList(java.lang.String name)
```
    Returns the parameter as a list of strings, or null if the parameter is not set
  - isSet
```
boolean isSet(java.lang.String name)
```
    Returns whether the given parameter is set
  - remove
```
void remove(java.lang.String name)
```
    Removes the parameter with the given name
  - setBoolean
```
void setBoolean(java.lang.String name,
                boolean value)
```
    Sets the parameter with the given name as a boolean value
  - setDecimal
```
void setDecimal(java.lang.String name,
                java.math.BigDecimal... values)
```
    Sets the parameter with the given name as a decimal or a list of decimals
  - setEnum
```
void setEnum(java.lang.String name,
             java.lang.Enum<?>... values)
```
    Sets the parameter with the given name as an enum or a list of enums
  - setInteger
```
void setInteger(java.lang.String name,
                java.lang.Integer... values)
```
    Sets the parameter with the given name as a integer or a list of integer
  - setLong
```
void setLong(java.lang.String name,
             java.lang.Long... values)
```
    Sets the parameter with the given name as a long or a list of long
  - setString
```
void setString(java.lang.String name,
               java.lang.String... values)
```
    Sets the parameter with the given name as a string or a list of strings

Interface ParameterStorage

Method Summary

Method Detail

getBoolean

getDecimal

getDecimalList

getEnum

getEnumList

getInteger

getIntegerList

getLong

getLongList

getNames

getString

getStringList

isSet

remove

setBoolean

setDecimal

setEnum

setInteger

setLong

setString