| java.lang.Object | |
| ↳ | com.pnfsoftware.jeb.core.UserDataSupport |
Class Overview
Standard implementation of the user-data support decorator interface.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| UserDataSupport() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| void |
clearAllData(Object key)
Remove all pieces of custom unit data.
| ||||||||||
| Map<Object, Object> |
getAllData()
Retrieve a map containing all key-value pairs of of custom unit data.
| ||||||||||
| Object |
getData(Object key)
Retrieve a piece of custom unit data.
| ||||||||||
| void |
setData(Object key, Object value, boolean persist)
Store a piece of custom unit data.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
|
From interface
com.pnfsoftware.jeb.core.IUserDataSupport
| |||||||||||
Public Constructors
public UserDataSupport ()
Public Methods
public void clearAllData (Object key)
Remove all pieces of custom unit data.
public Map<Object, Object> getAllData ()
Retrieve a map containing all key-value pairs of of custom unit data.
Returns
- a map
public Object getData (Object key)
Retrieve a piece of custom unit data.
Parameters
| key | non-null key |
|---|
Returns
- value (null may indicate that the key-value pair is not present or that the stored value is null)
public void setData (Object key, Object value, boolean persist)
Store a piece of custom unit data.
Parameters
| key | non-null key |
|---|---|
| value | optional value (may be null) |
| persist | if false, the piece of data is transient and will not be persisted to disk
when saving the project to a JEB database; if true, the piece of data will be
persisted, in which case, user of this method must ensure that both key and value
are serializable; if unsure, it is recommended to either not persist
the data, or if persistence is a requirement, use only key/value types that are
guaranteed to be persisted, such as any basic types (String, boxed primitive
types, primitive types, arrays or lists of those, etc.)
|