incubator-kato-commits mailing list archives

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

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

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

Modified: incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaField.java
URL: http://svn.apache.org/viewvc/incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaField.java?rev=800551&r1=800550&r2=800551&view=diff
==============================================================================
--- incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaField.java
(original)
+++ incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaField.java
Mon Aug  3 20:36:35 2009
@@ -17,25 +17,29 @@
 import javax.tools.diagnostics.image.MemoryAccessException;
 
 /**
+ * <p>
  * Represents a field declaration.
  * It is modelled on {@link java.lang.reflect.Field}
  */
 public interface JavaField extends JavaMember {
 
     /**
+     * <p>
      * Get the contents of an Object field
      * 
      * @param object to fetch the field from. Ignored for static
      * fields.
      * 
-     * @return a JavaObject instance for reference type fields,
-     * an instance of a subclass of Number, Boolean, or Character 
-     * for primitive fields, or null for null reference fields.
+     * 
      * <p>
      * This field must be declared in the object's class or in a superclass
      * <p>
-     * @throws CorruptDataException 
-     * @throws MemoryAccessException 
+     * @return a JavaObject instance for reference type fields,
+     * an instance of a subclass of Number, Boolean, or Character 
+     * for primitive fields, or null for null reference fields.
+     * 
+     * @throws CorruptDataException if the underlying data is in an unexpected state 
+     * @throws MemoryAccessException  
      * @throws NullPointerException if the field is an instance field, and object is null
      * @throws IllegalArgumentException if the specified object is not appropriate for
      * this field
@@ -53,10 +57,11 @@
     Object get(JavaObject object) throws CorruptDataException, MemoryAccessException;
 
     /**
+     * <p>
      * Get the contents of a boolean field
      * @param  object to fetch the field from. Ignored for static fields.
      * @return the field contents
-     * @throws CorruptDataException 
+     * @throws CorruptDataException if the underlying data is in an unexpected state 
      * @throws MemoryAccessException 
      * @throws NullPointerException if the field is an instance field, and object is null
      * @throws IllegalArgumentException if the specified object is not appropriate for
@@ -65,10 +70,11 @@
     boolean getBoolean(JavaObject object) throws CorruptDataException, MemoryAccessException;
 
     /**
+     * <p>
      * Get the contents of a byte field
      * @param  object to fetch the field from. Ignored for static fields.
      * @return the field contents
-     * @throws CorruptDataException 
+     * @throws CorruptDataException if the underlying data is in an unexpected state 
      * @throws MemoryAccessException 
      * @throws NullPointerException if the field is an instance field, and object is null
      * @throws IllegalArgumentException if the specified object is not appropriate for
@@ -77,10 +83,11 @@
     byte getByte(JavaObject object) throws CorruptDataException, MemoryAccessException;
 
     /**
+     * <p>
      * Get the contents of a char field
      * @param  object to fetch the field from. Ignored for static fields.
      * @return the field contents
-     * @throws CorruptDataException 
+     * @throws CorruptDataException if the underlying data is in an unexpected state 
      * @throws MemoryAccessException 
      * @throws NullPointerException if the field is an instance field, and object is null
      * @throws IllegalArgumentException if the specified object is not appropriate for
@@ -89,10 +96,11 @@
     char getChar(JavaObject object) throws CorruptDataException, MemoryAccessException;
 
     /**
+     * <p>
      * Get the contents of a double field or of another primitive field whose type is convertible
to double via a widening conversion. 
      * @param  object to fetch the field from. Ignored for static fields.
      * @return the field contents
-     * @throws CorruptDataException 
+     * @throws CorruptDataException if the underlying data is in an unexpected state 
      * @throws MemoryAccessException 
      * @throws NullPointerException if the field is an instance field, and object is null
      * @throws IllegalArgumentException if the specified object is not appropriate for
@@ -101,10 +109,11 @@
     double getDouble(JavaObject object) throws CorruptDataException, MemoryAccessException;
 
     /**
+     * <p>
      * Get the contents of a float field or of another primitive field whose type is convertible
to float via a widening conversion. 
      * @param  object to fetch the field from. Ignored for static fields.
      * @return the field contents 
-     * @throws CorruptDataException 
+     * @throws CorruptDataException if the underlying data is in an unexpected state 
      * @throws MemoryAccessException 
      * @throws NullPointerException if the field is an instance field, and object is null
      * @throws IllegalArgumentException if the specified object is not appropriate for
@@ -113,10 +122,11 @@
     float getFloat(JavaObject object) throws CorruptDataException, MemoryAccessException;
 
     /**
+     * <p>
      * Get the contents of an int field or of another primitive field whose type is convertible
to int via a widening conversion.
      * @return the field contents
      * @param  object to fetch the field from. Ignored for static fields.
-     * @throws CorruptDataException 
+     * @throws CorruptDataException if the underlying data is in an unexpected state 
      * @throws MemoryAccessException 
      * @throws NullPointerException if the field is an instance field, and object is null
      * @throws IllegalArgumentException if the specified object is not appropriate for
@@ -125,10 +135,11 @@
     int getInt(JavaObject object) throws CorruptDataException, MemoryAccessException;
 
     /**
+     * <p>
      * Get the contents of a long field or of another primitive field whose type is convertible
to long via a widening conversion.
      * @param  object to fetch the field from. Ignored for static fields.
      * @return the field contents
-     * @throws CorruptDataException 
+     * @throws CorruptDataException if the underlying data is in an unexpected state 
      * @throws MemoryAccessException 
      * @throws NullPointerException if the field is an instance field, and object is null
      * @throws IllegalArgumentException if the specified object is not appropriate for
@@ -137,10 +148,11 @@
     long getLong(JavaObject object) throws CorruptDataException, MemoryAccessException;
 
     /**
+     * <p>
      * Get the contents of a short field or of another primitive field whose type is convertible
to short via a widening conversion.
      * @param  object to fetch the field from. Ignored for static fields.
      * @return the field contents 
-     * @throws CorruptDataException 
+     * @throws CorruptDataException if the underlying data is in an unexpected state 
      * @throws MemoryAccessException 
      * @throws NullPointerException if the field is an instance field, and object is null
      * @throws IllegalArgumentException if the specified object is not appropriate for
@@ -149,12 +161,13 @@
     short getShort(JavaObject object) throws CorruptDataException, MemoryAccessException;
     
     /**
+     * <p>
      * Get the contents of a string field
      * @param object to fetch the field from. Ignored for static fields.
      * 
      * @return a String representing the value of the String field.  Note that the instance
      * returned can be null if the field was null in object.
-     * @throws CorruptDataException 
+     * @throws CorruptDataException if the underlying data is in an unexpected state 
      * @throws MemoryAccessException 
      * 
      * @throws IllegalArgumentException if the specified field is not a String



Mime
View raw message