incubator-kato-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From spo...@apache.org
Subject svn commit: r800557 - /incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaClass.java
Date Mon, 03 Aug 2009 20:48:43 GMT
Author: spoole
Date: Mon Aug  3 20:48:43 2009
New Revision: 800557

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

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

Modified: incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaClass.java
URL: http://svn.apache.org/viewvc/incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaClass.java?rev=800557&r1=800556&r2=800557&view=diff
==============================================================================
--- incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaClass.java
(original)
+++ incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaClass.java
Mon Aug  3 20:48:43 2009
@@ -21,8 +21,9 @@
 
 
 /**
+ * <p>
  * Represents a Java class.
- * 
+ * <p>
  * A Java Class can have fields and methods. It is a shallow model of a loaded <a href="http://java.sun.com/docs/books/jvms/second_edition/html/ClassFile.doc.html">class
file</a>
  * or special types such as array types or primitive types in the Java Virtual Machine. 

  * 
@@ -37,7 +38,7 @@
      * created to represent this class, or if the class is synthetic.
      * </p>
      * @return the java.lang.Class object associated with this class 
-     * @throws CorruptDataException 
+     * @throws CorruptDataException if the underlying data is in an unexpected state 
      * 
      * @see #getID()
      */
@@ -63,7 +64,7 @@
      *   
      * @return the name of the class
      * 
-     * @throws CorruptDataException 
+     * @throws CorruptDataException  if the underlying data is in an unexpected state
      */
     String getName() throws CorruptDataException;
     
@@ -78,7 +79,7 @@
   	 *</p>
      * @return the immediate superclass of this class, or null if this class has no superclass.
      * 
-     * @throws CorruptDataException 
+     * @throws CorruptDataException if the underlying data is in an unexpected state
      */
     JavaClass getSuperclass() throws CorruptDataException;
     
@@ -109,7 +110,7 @@
      * member, since 'protected' is not a legal modifier for a class file.
      * </p>
      * @return the modifiers for this class
-     * @throws CorruptDataException 
+     * @throws CorruptDataException if the underlying data is in an unexpected state
      */
     int getModifiers() throws CorruptDataException;
     
@@ -117,7 +118,7 @@
      * This method returns true if the class represented by this JavaClass is an array class.
      * 
      * @return true if this class is an array class
-     * @throws CorruptDataException 
+     * @throws CorruptDataException if the underlying data is in an unexpected state
      */
     boolean isArray() throws CorruptDataException;
     
@@ -125,9 +126,9 @@
      * For array classes, returns a JavaClass representing the component type of this array
class.
      *
      * @return a JavaClass representing the component type of this array class
-     * @throws CorruptDataException 
+     * @throws CorruptDataException if the underlying data is in an unexpected state
      * 
-     * @exception java.lang.IllegalArgumentException if this JavaClass does not represent
an array class
+     * @throws java.lang.IllegalArgumentException if this JavaClass does not represent an
array class
      */
     JavaClass getComponentType() throws CorruptDataException;
     
@@ -158,8 +159,9 @@
     List<JavaMethod> getDeclaredMethods();
     
     /**
+     * <p>
      * Returns the list of constant pool references defined by this class.
-     * 
+     * <p>
      * Java classes may refer to other classes and to String objects via 
      * the class's constant pool. These references are followed by the 
      * garbage collector, forming edges on the graph of reachable objects.
@@ -208,6 +210,7 @@
 	ImagePointer getID();
 	
 	/**
+	 * <p>
 	 * Get the set of references from this class. 
 	 * <p>
 	 * A reference is a object that represents the uni-directional relationship between objects
and classes.



Mime
View raw message