Attachment 164872 Details for Bug 122341 – doc update v01

[patch] doc update v01

memento-v01.txt (text/plain), 3.01 KB, created by Paul Webster

on 2010-04-14 14:45:08 EDT

(hide)

Description:

Filename:

MIME Type:

Creator: Paul Webster

Created: 2010-04-14 14:45:08 EDT

Size: 3.01 KB

patch

obsolete

>### Eclipse Workspace Patch 1.0
>#P org.eclipse.ui.workbench
>Index: Eclipse UI/org/eclipse/ui/IMemento.java
>===================================================================
>RCS file: /cvsroot/eclipse/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IMemento.java,v
>retrieving revision 1.16
>diff -u -r1.16 IMemento.java
>--- Eclipse UI/org/eclipse/ui/IMemento.java	9 May 2008 14:13:11 -0000	1.16
>+++ Eclipse UI/org/eclipse/ui/IMemento.java	14 Apr 2010 18:41:03 -0000
>@@ -11,32 +11,35 @@
> package org.eclipse.ui;
> 
> /**
>- * Interface to a memento used for saving the important state of an object
>- * in a form that can be persisted in the file system.
>+ * 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:
> * <ol>
>- * <li>Certain objects need to be saved and restored across platform sessions.
>- * </li>
>- * <li>When an object is restored, an appropriate class for an object might not
>- * be available. It must be possible to skip an object in this case.</li>
>- * <li>When an object is restored, the appropriate class for the object may be
>- * different from the one when the object was originally saved. If so, the
>- * new class should still be able to read the old form of the data.</li>
>+ * <li>Certain objects need to be saved and restored across platform sessions.</li>
>+ * <li>When an object is restored, an appropriate class for an object might not
>+ * be available. It must be possible to skip an object in this case.</li>
>+ * <li>When an object is restored, the appropriate class for the object may be
>+ * different from the one when the object was originally saved. If so, the new
>+ * class should still be able to read the old form of the data.</li>
> * </ol>
> * 
> * 
>- * 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 <code>TAG_ID</code> is reserved for internal use.
>- * 
>+ * 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, or a valid XML <a
>+ * href="http://www.w3.org/TR/REC-xml/#NT-Name">Name</a>. However, the value of
>+ * <code>TAG_ID</code> is reserved for internal use.
>+ * 
>+ * 
> * This interface is not intended to be implemented or extended by clients.
> * 
>- *
>+ * 
> * @see IPersistableElement
> * @see IElementFactory
> * @noimplement This interface is not intended to be implemented by clients.

Actions: View | Diff

Attachments on bug 122341: 164872