AbstractParameterStorage (Cyclos 4.6 Scripting API Documentation)

java.lang.Object
- org.cyclos.utils.AbstractParameterStorage

All Implemented Interfaces:

ParameterStorage

Direct Known Subclasses:

MapParameterStorage
```
public abstract class AbstractParameterStorage
extends java.lang.Object
implements ParameterStorage
```
Base implementation for ParameterStorage, based on the storage as string

Author:

luis

Constructor Summary

Constructors
Constructor and Description

AbstractParameterStorage()

Constructors
Constructor and Description
`AbstractParameterStorage()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`doSet(java.lang.String name, java.util.List<java.lang.String> values)` Must be implemented to actually set the underlying value as a list of strings
`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> enumClass)` 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
`boolean`	`isSet(java.lang.String name)` Returns whether the given parameter is set
`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
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cyclos.utils.ParameterStorage
getNames, getString, getStringList, remove

- Constructor Detail
  - AbstractParameterStorage
```
public AbstractParameterStorage()
```
- Method Detail
  - getBoolean
```
public final boolean getBoolean(java.lang.String name)
```
    Description copied from interface: ParameterStorage
    
    Returns a parameter as a boolean value
    
    Specified by:
    
    getBoolean in interface ParameterStorage
  - getDecimal
```
public final java.math.BigDecimal getDecimal(java.lang.String name)
```
    Description copied from interface: ParameterStorage
    
    Returns a parameter as a decimal value, or null if the parameter is not set
    
    Specified by:
    
    getDecimal in interface ParameterStorage
  - getDecimalList
```
public final java.util.List<java.math.BigDecimal> getDecimalList(java.lang.String name)
```
    Description copied from interface: ParameterStorage
    
    Returns a parameter as a decimal list, or null if the parameter is not set
    
    Specified by:
    
    getDecimalList in interface ParameterStorage
  - getEnum
```
public final <T extends java.lang.Enum<T>> T getEnum(java.lang.String name,
                                                     java.lang.Class<T> enumClass)
```
    Description copied from interface: ParameterStorage
    
    Returns a parameter as an enumerated value, with the given class, or null if the parameter is not set
    
    Specified by:
    
    getEnum in interface ParameterStorage
  - getEnumList
```
public final <T extends java.lang.Enum<T>> java.util.List<T> getEnumList(java.lang.String name,
                                                                         java.lang.Class<T> enumType)
```
    Description copied from interface: ParameterStorage
    
    Returns a parameter as a list of enumerated values, with the given class, or null if the parameter is not set
    
    Specified by:
    
    getEnumList in interface ParameterStorage
  - getInteger
```
public final java.lang.Integer getInteger(java.lang.String name)
```
    Description copied from interface: ParameterStorage
    
    Returns a parameter as a integer, or null if the parameter is not set
    
    Specified by:
    
    getInteger in interface ParameterStorage
  - getIntegerList
```
public final java.util.List<java.lang.Integer> getIntegerList(java.lang.String name)
```
    Description copied from interface: ParameterStorage
    
    Returns a parameter as a list of integers, or null if the parameter is not set
    
    Specified by:
    
    getIntegerList in interface ParameterStorage
  - getLong
```
public final java.lang.Long getLong(java.lang.String name)
```
    Description copied from interface: ParameterStorage
    
    Returns a parameter as a long, or null if the parameter is not set
    
    Specified by:
    
    getLong in interface ParameterStorage
  - getLongList
```
public final java.util.List<java.lang.Long> getLongList(java.lang.String name)
```
    Description copied from interface: ParameterStorage
    
    Returns a parameter as a list of longs, or null if the parameter is not set
    
    Specified by:
    
    getLongList in interface ParameterStorage
  - isSet
```
public final boolean isSet(java.lang.String name)
```
    Description copied from interface: ParameterStorage
    
    Returns whether the given parameter is set
    
    Specified by:
    
    isSet in interface ParameterStorage
  - setBoolean
```
public final void setBoolean(java.lang.String name,
                             boolean value)
```
    Description copied from interface: ParameterStorage
    
    Sets the parameter with the given name as a boolean value
    
    Specified by:
    
    setBoolean in interface ParameterStorage
  - setDecimal
```
public final void setDecimal(java.lang.String name,
                             java.math.BigDecimal... values)
```
    Description copied from interface: ParameterStorage
    
    Sets the parameter with the given name as a decimal or a list of decimals
    
    Specified by:
    
    setDecimal in interface ParameterStorage
  - setEnum
```
public final void setEnum(java.lang.String name,
                          java.lang.Enum<?>... values)
```
    Description copied from interface: ParameterStorage
    
    Sets the parameter with the given name as an enum or a list of enums
    
    Specified by:
    
    setEnum in interface ParameterStorage
  - setInteger
```
public final void setInteger(java.lang.String name,
                             java.lang.Integer... values)
```
    Description copied from interface: ParameterStorage
    
    Sets the parameter with the given name as a integer or a list of integer
    
    Specified by:
    
    setInteger in interface ParameterStorage
  - setLong
```
public final void setLong(java.lang.String name,
                          java.lang.Long... values)
```
    Description copied from interface: ParameterStorage
    
    Sets the parameter with the given name as a long or a list of long
    
    Specified by:
    
    setLong in interface ParameterStorage
  - setString
```
public final void setString(java.lang.String name,
                            java.lang.String... values)
```
    Description copied from interface: ParameterStorage
    
    Sets the parameter with the given name as a string or a list of strings
    
    Specified by:
    
    setString in interface ParameterStorage
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - doSet
```
protected abstract void doSet(java.lang.String name,
                              java.util.List<java.lang.String> values)
```
    Must be implemented to actually set the underlying value as a list of strings

Class AbstractParameterStorage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.cyclos.utils.ParameterStorage

Constructor Detail

AbstractParameterStorage

Method Detail

getBoolean

getDecimal

getDecimalList

getEnum

getEnumList

getInteger

getIntegerList

getLong

getLongList

isSet

setBoolean

setDecimal

setEnum

setInteger

setLong

setString

toString

doSet