|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface IMemento
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 that doesn't start
with a number. eg: [A-Za-z][A-Za-z0-9]* Using '.' is unsupported. 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 java.lang.String |
TAG_ID
Special reserved key used to store the memento id (value "IMemento.internal.id"). |
| Method Summary | |
|---|---|
IMemento |
createChild(java.lang.String type)
Creates a new child of this memento with the given type. |
IMemento |
createChild(java.lang.String type,
java.lang.String id)
Creates a new child of this memento with the given type and id. |
java.lang.String[] |
getAttributeKeys()
Returns an array of all the attribute keys of the memento. |
java.lang.Boolean |
getBoolean(java.lang.String key)
Returns the boolean value of the given key. |
IMemento |
getChild(java.lang.String type)
Returns the first child with the given type id. |
IMemento[] |
getChildren(java.lang.String type)
Returns all children with the given type id. |
java.lang.Float |
getFloat(java.lang.String key)
Returns the floating point value of the given key. |
java.lang.String |
getID()
Returns the id for this memento. |
java.lang.Integer |
getInteger(java.lang.String key)
Returns the integer value of the given key. |
java.lang.String |
getString(java.lang.String key)
Returns the string value of the given key. |
java.lang.String |
getTextData()
Returns the data of the Text node of the memento. |
java.lang.String |
getType()
Returns the type for this memento. |
void |
putBoolean(java.lang.String key,
boolean value)
Sets the value of the given key to the given boolean value. |
void |
putFloat(java.lang.String key,
float value)
Sets the value of the given key to the given floating point number. |
void |
putInteger(java.lang.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(java.lang.String key,
java.lang.String value)
Sets the value of the given key to the given string. |
void |
putTextData(java.lang.String data)
Sets the memento's Text node to contain the given data. |
| Field Detail |
|---|
static final java.lang.String TAG_ID
"IMemento.internal.id").
getID(),
Constant Field Values| Method Detail |
|---|
IMemento createChild(java.lang.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)
IMemento createChild(java.lang.String type,
java.lang.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()IMemento getChild(java.lang.String type)
type - the type id
IMemento[] getChildren(java.lang.String type)
type - the type id
java.lang.Float getFloat(java.lang.String key)
key - the key
null if the key was not found or was found
but was not a floating point numberjava.lang.String getType()
createChild(java.lang.String),
createChild(java.lang.String,java.lang.String)java.lang.String getID()
null if nonecreateChild(java.lang.String,java.lang.String)java.lang.Integer getInteger(java.lang.String key)
key - the key
null if the key was not found or was found
but was not an integerjava.lang.String getString(java.lang.String key)
key - the key
null if the key was not foundjava.lang.Boolean getBoolean(java.lang.String key)
key - the key
null if the key was not foundjava.lang.String getTextData()
null
if the memento has no Text node.java.lang.String[] getAttributeKeys()
null. If there are no keys, an array of length zero will
be returned.
void putFloat(java.lang.String key,
float value)
key - the keyvalue - the value
void putInteger(java.lang.String key,
int value)
key - the keyvalue - the valuevoid putMemento(IMemento memento)
memento
to the receiver.
memento - the IMemento to be copied.
void putString(java.lang.String key,
java.lang.String value)
key - the keyvalue - the value
void putBoolean(java.lang.String key,
boolean value)
key - the keyvalue - the valuevoid putTextData(java.lang.String data)
data - the data to be placed on the Text node
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.