Author: spoole
Date: Mon Aug 3 20:43:31 2009
New Revision: 800554
URL: http://svn.apache.org/viewvc?rev=800554&view=rev
Log:
updated Javareference javadoc
Modified:
incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaReference.java
Modified: incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaReference.java
URL: http://svn.apache.org/viewvc/incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaReference.java?rev=800554&r1=800553&r2=800554&view=diff
==============================================================================
--- incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaReference.java
(original)
+++ incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaReference.java
Mon Aug 3 20:43:31 2009
@@ -17,7 +17,15 @@
import javax.tools.diagnostics.image.DataUnavailable;
/**
- * Represents a Java reference.
+ * <p>
+ * Represents a Java reference.
+ * <p>
+ * A Java reference is a traceable relationship between two objects or between a root
+ * and a Java object.
+ * <p>
+ * References are used by Garbage Collection systems to identify objects that can be
+ * reclaimed.
+ *
*/
public interface JavaReference
{
@@ -90,6 +98,7 @@
int REACHABILITY_PHANTOM = 4;
/**
+ * <p>
* Get the root type, as defined in the JVMTI specification.
*
* @return an integer representing the root type, see HEAP_ROOT_ statics above.
@@ -97,19 +106,23 @@
int getRootType() throws CorruptDataException;
/**
+ * <p>
* Get the reference type, as defined in the JVMTI specification.
* @return an integer representing the reference type, see REFERENCE_ statics above.
*/
int getReferenceType() throws CorruptDataException;
/**
+ * <p>
* Get the reachability of the target object via this specific reference.
* @return an integer representing the reachability, see REACHABILITY_ statics above.
*/
int getReachability() throws CorruptDataException;
/**
+ * <p>
* Get a string describing the reference type.
+ * <p>
* Implementors should not depend on the contents or identity of this string.
* e.g. "JNI Weak global reference", "Instance field 'MyClass.value'", "Constant pool
string constant"
* @return a String describing the reference type
@@ -117,26 +130,39 @@
String getDescription();
/**
- * Does this reference point to an object in the heap?
+ * <p>
+ * Check to see if this reference points to an object in the heap
* @return true if the target of this root is an object
+ * @throws DataUnavailable if the requested information is not available
+ * @throws CorruptDataException is the underlying data is in an unexpected state
*/
boolean isObjectReference() throws DataUnavailable, CorruptDataException;
/**
- * Does this reference point to a class?
+ * <p>
+ * Check to see if this reference points to a class.
+ *
* @return true if the target of this root is a class
+ * @throws DataUnavailable if the requested information is not available
+ * @throws CorruptDataException is the underlying data is in an unexpected state
*/
boolean isClassReference() throws DataUnavailable, CorruptDataException;
/**
+ * >p>
* Get the object referred to by this reference.
* @return a JavaObject or a JavaClass
+ * @throws DataUnavailable if the requested information is not available
+ * @throws CorruptDataException is the underlying data is in an unexpected state
*/
Object getTarget() throws DataUnavailable, CorruptDataException;
/**
+ * <p>
* Get the source of this reference if available.
* @return a JavaClass, JavaObject, JavaStackFrame or null if unknown
+ * @throws DataUnavailable if the requested information is not available
+ * @throws CorruptDataException is the underlying data is in an unexpected state
*/
Object getSource() throws DataUnavailable, CorruptDataException;
}
|