summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorpelder2007-09-17 16:48:33 (EDT)
committerpelder2007-09-17 16:48:33 (EDT)
commitf5f4dd1dac9feb263269867e7009d12d6f965bb2 (patch)
treebcc113987456bec09ed8e881e84bbdcd491bd681
parent239812e0ab3b468ded634a512b97ab939c6f47b2 (diff)
downloadorg.eclipse.jet-f5f4dd1dac9feb263269867e7009d12d6f965bb2.zip
org.eclipse.jet-f5f4dd1dac9feb263269867e7009d12d6f965bb2.tar.gz
org.eclipse.jet-f5f4dd1dac9feb263269867e7009d12d6f965bb2.tar.bz2
[175704] Improve javadoc
-rw-r--r--plugins/org.eclipse.jet.core/src/org/eclipse/jet/AbstractContextExtender.java18
1 files changed, 15 insertions, 3 deletions
diff --git a/plugins/org.eclipse.jet.core/src/org/eclipse/jet/AbstractContextExtender.java b/plugins/org.eclipse.jet.core/src/org/eclipse/jet/AbstractContextExtender.java
index 9bcf90e..8dd8794 100644
--- a/plugins/org.eclipse.jet.core/src/org/eclipse/jet/AbstractContextExtender.java
+++ b/plugins/org.eclipse.jet.core/src/org/eclipse/jet/AbstractContextExtender.java
@@ -10,7 +10,7 @@
*
* </copyright>
*
- * $Id: AbstractContextExtender.java,v 1.2 2007/04/12 18:02:43 pelder Exp $
+ * $Id: AbstractContextExtender.java,v 1.3 2007/09/17 20:48:33 pelder Exp $
* /
*******************************************************************************/
@@ -18,8 +18,20 @@ package org.eclipse.jet;
/**
- * A base class for extending the JET2 context.
- *
+ * Base class for extending {@link JET2Context}. The JET execution context, {@link JET2Context}, is capable of
+ * storing private data for various extensions. Subclass this class to create such a private data extension. Steps to create an context
+ * extension.
+ * <ol>
+ * <li>Subclass this class</li>
+ * <li>Implement {@link #createExtendedData(JET2Context)} to return a object representing the private data of the context extension. This method is only called the first time
+ * an extender is constructed for a particular context.
+ * The method {@link #getExtendedData()} returns the data to the current context instance.</li>
+ * <li>Implement additional methods that make use of this private context data.</li>
+ * <li>Create a constructor that accepts a {@link JET2Context} and passes it to the super constructor. It is recommended that
+ * this constructor be private.</li>
+ * <li> (Recommended) Implement a <code>public static <i>YourExtender</i> getInstance(JET2Context)</code> method that returns an instance the
+ * AbstractContextExtender subclass.</li>
+ * </ol>
*/
public abstract class AbstractContextExtender
{