incubator-kato-commits mailing list archives

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

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

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

Modified: incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaLocation.java
URL: http://svn.apache.org/viewvc/incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaLocation.java?rev=800537&r1=800536&r2=800537&view=diff
==============================================================================
--- incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaLocation.java
(original)
+++ incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaLocation.java
Mon Aug  3 20:29:51 2009
@@ -18,12 +18,14 @@
 import javax.tools.diagnostics.image.ImagePointer;
 
 /**
+ * <p>
  * Represents a point of execution within a Java method
  * 
  */
 public interface JavaLocation {
 	
 	/**
+	 * <p>
 	 * Fetches the absolute address of the code which this location represents.
 	 * This pointer will be contained within one of the segments returned by
 	 * getBytecodeSections() or getCompiledSections() of the method returned by
@@ -41,32 +43,36 @@
 	 * For native methods, the address may be meaningless.
 	 * 
 	 * @return the address in memory of the managed code
-	 * @throws CorruptDataException 
+	 * @throws CorruptDataException if the underlying data is in an unexpected state 
 	 */
 	ImagePointer getAddress() throws CorruptDataException;
 	
 	/**
+	 * <p>
 	 * Get the line number.
-	 * 
+	 * <p>
 	 * @return the line number, if available, or throws DataUnavailable if it is not available
 	 * Line numbers are counted from 1  
 	 * 
 	 * @throws DataUnavailable if the line number data is not available for this location
-	 * @throws CorruptDataException 
+	 * @throws CorruptDataException if the underlying data is in an unexpected state 
 	 */
 	int getLineNumber() throws DataUnavailable, CorruptDataException;
 	
 	/**
+	 * <p>
 	 * Get the source file name.
+	 * 
 	 * @return the name of the source file, if available, or throws DataUnavailable if it is
 	 * not available
 	 * 
 	 * @throws DataUnavailable if the source file name is unavailable in the core
-	 * @throws CorruptDataException 
+	 * @throws CorruptDataException  if the underlying data is in an unexpected state 
 	 */
 	String getFilename() throws DataUnavailable, CorruptDataException;
 	
 	/**
+	 * <p>
 	 * Get the compilation level for this location. This is an implementation 
 	 * defined number indicating the level at which the current location was 
 	 * compiled. 0 indicates interpreted. Any positive number indicates some 
@@ -79,14 +85,16 @@
 	 * getMethod().getModifiers().
 	 * 
 	 * @return the compilation level 
-	 * @throws CorruptDataException 
+	 * @throws CorruptDataException if the underlying data is in an unexpected state  
 	 */
 	int getCompilationLevel() throws CorruptDataException;
 	
 	/**
+	 * <p>
 	 * Get the method which contains the point of execution.
+	 * 
 	 * @return the method which contains the point of execution
-	 * @throws CorruptDataException 
+	 * @throws CorruptDataException if the underlying data is in an unexpected state  
 	 */
 	JavaMethod getMethod() throws CorruptDataException;
 	



Mime
View raw message