public interface

IUserDataSupport

com.pnfsoftware.jeb.core.IUserDataSupport
Known Indirect Subclasses

Class Overview

This decorator interface is used to let users know that arbitrary data objects may be attached to the object. The attached objects (both keys and values) must be serializable since this interface is itself serializable.

Summary

Public Methods
abstract void clearAllData(Object key)
Remove all pieces of custom unit data.
abstract Map<Object, Object> getAllData()
Retrieve a map containing all key-value pairs of of custom unit data.
abstract Object getData(Object key)
Retrieve a piece of custom unit data.
abstract void setData(Object key, Object value, boolean persist)
Store a piece of custom unit data.

Public Methods

public abstract void clearAllData (Object key)

Remove all pieces of custom unit data.

public abstract Map<Object, Object> getAllData ()

Retrieve a map containing all key-value pairs of of custom unit data.

Returns
  • a map

public abstract 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 abstract 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.)