|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface to a memento used for saving the important state of an object in a form that can be persisted in the file system.
Mementos were designed with the following requirements in mind:
Mementos meet these requirements by providing support for storing a mapping of arbitrary string keys to primitive values, and by allowing mementos to have other mementos as children (arranged into a tree). A robust external storage format based on XML is used.
The key for an attribute may be any alpha numeric value. However, the
value of TAG_ID
is reserved for internal use.
This interface is not intended to be implemented or extended by clients.
IPersistableElement
,
IElementFactory
Field Summary | |
static String |
TAG_ID
Special reserved key used to store the memento id (value "org.eclipse.ui.id" ). |
Method Summary | |
IMemento |
createChild(String type)
Creates a new child of this memento with the given type. |
IMemento |
createChild(String type,
String id)
Creates a new child of this memento with the given type and id. |
IMemento |
getChild(String type)
Returns the first child with the given type id. |
IMemento[] |
getChildren(String type)
Returns all children with the given type id. |
Float |
getFloat(String key)
Returns the floating point value of the given key. |
String |
getID()
Returns the id for this memento. |
Integer |
getInteger(String key)
Returns the integer value of the given key. |
String |
getString(String key)
Returns the string value of the given key. |
String |
getTextData()
Returns the data of the Text node of the memento. |
void |
putFloat(String key,
float value)
Sets the value of the given key to the given floating point number. |
void |
putInteger(String key,
int value)
Sets the value of the given key to the given integer. |
void |
putMemento(IMemento memento)
Copy the attributes and children from memento
to the receiver. |
void |
putString(String key,
String value)
Sets the value of the given key to the given string. |
void |
putTextData(String data)
Sets the memento's Text node to contain the given data. |
Field Detail |
public static final String TAG_ID
"org.eclipse.ui.id"
).
#getId
,
Constant Field ValuesMethod Detail |
public IMemento createChild(String type)
The getChild
and getChildren
methods
are used to retrieve children of a given type.
type
- the type
getChild(java.lang.String)
,
getChildren(java.lang.String)
public IMemento createChild(String type, String id)
TAG_ID
) and can be retrieved using getId
.
The getChild
and getChildren
methods
are used to retrieve children of a given type.
type
- the typeid
- the child id
#getId
public IMemento getChild(String type)
type
- the type id
public IMemento[] getChildren(String type)
type
- the type id
public Float getFloat(String key)
key
- the key
null
if the key was not found or was found
but was not a floating point numberpublic String getID()
[Issue: For consistency, rename to "getId".]
null
if nonecreateChild(java.lang.String,java.lang.String)
public Integer getInteger(String key)
key
- the key
null
if the key was not found or was found
but was not an integerpublic String getString(String key)
key
- the key
null
if the key was not found or was found
but was not an integerpublic String getTextData()
null
if the memento has no Text node.public void putFloat(String key, float value)
key
- the keyvalue
- the valuepublic void putInteger(String key, int value)
key
- the keyvalue
- the valuepublic void putMemento(IMemento memento)
memento
to the receiver.
memento
- the IMemento to be copied.public void putString(String key, String value)
key
- the keyvalue
- the valuepublic void putTextData(String data)
data
- the data to be placed on the Text node
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |