svn commit: r897822 - /incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/Handle.java

[sp...@apache.org]

Author: spoole
Date: Mon Jan 11 09:53:52 2010
New Revision: 897822

URL: http://svn.apache.org/viewvc?rev=897822&view=rev
Log:
updated handle javadoc

Modified:
    incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/Handle.java

Modified: incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/Handle.java
URL: http://svn.apache.org/viewvc/incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/Handle.java?rev=897822&r1=897821&r2=897822&view=diff
==============================================================================
--- incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/Handle.java (original)
+++ incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/Handle.java Mon Jan 11 09:53:52 2010
@@ -13,6 +13,20 @@
  ******************************************************************************/
 package javax.tools.diagnostics.runtime.java;
 
+/**
+ * Describes a smart pointer that can be used to extract
+ * a reference to an entity within a JavaRuntime instance
+ * and can be presented to the same JavaRuntime instance to
+ * reconstitute a semantically equivilent version of the original
+ * entity.
+ * 
+ * The handle is expected to be used to facilitate round tripping
+ * where identity information about the entity needs to recorded outside of a
+ * the analysing program (perhaps in a database) and then, at some later
+ * stage , the original object needs to be recovered.
+ * 
+ * 
+ */
 public interface Handle {
 
 	/**