lucene-java-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From busc...@apache.org
Subject svn commit: r545693 - in /lucene/java: branches/lucene_2_2/src/java/org/apache/lucene/index/Payload.java trunk/src/java/org/apache/lucene/index/Payload.java
Date Sat, 09 Jun 2007 04:52:41 GMT
Author: buschmi
Date: Fri Jun  8 21:52:38 2007
New Revision: 545693

URL: http://svn.apache.org/viewvc?view=rev&rev=545693
Log:
LUCENE-917: Javadoc improvements for org.apache.lucene.index.Payload

Modified:
    lucene/java/branches/lucene_2_2/src/java/org/apache/lucene/index/Payload.java
    lucene/java/trunk/src/java/org/apache/lucene/index/Payload.java

Modified: lucene/java/branches/lucene_2_2/src/java/org/apache/lucene/index/Payload.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/lucene_2_2/src/java/org/apache/lucene/index/Payload.java?view=diff&rev=545693&r1=545692&r2=545693
==============================================================================
--- lucene/java/branches/lucene_2_2/src/java/org/apache/lucene/index/Payload.java (original)
+++ lucene/java/branches/lucene_2_2/src/java/org/apache/lucene/index/Payload.java Fri Jun
 8 21:52:38 2007
@@ -41,10 +41,16 @@
   */    
   // TODO: Remove warning after API has been finalized
   public class Payload implements Serializable {
+    /** the byte array containing the payload data */
     protected byte[] data;
+    
+    /** the offset within the byte array */
     protected int offset;
+    
+    /** the length of the payload data */
     protected int length;
     
+    /** Creates an empty payload and does not allocate a byte array. */
     protected Payload() {
       // no-arg constructor since this class implements Serializable
     }
@@ -74,6 +80,9 @@
       this.length = length;
     }
     
+    /**
+     * Returns the length of the payload data. 
+     */
     public int length() {
       return this.length;
     }

Modified: lucene/java/trunk/src/java/org/apache/lucene/index/Payload.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/index/Payload.java?view=diff&rev=545693&r1=545692&r2=545693
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/index/Payload.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/index/Payload.java Fri Jun  8 21:52:38 2007
@@ -41,10 +41,16 @@
   */    
   // TODO: Remove warning after API has been finalized
   public class Payload implements Serializable {
+    /** the byte array containing the payload data */
     protected byte[] data;
+    
+    /** the offset within the byte array */
     protected int offset;
+    
+    /** the length of the payload data */
     protected int length;
     
+    /** Creates an empty payload and does not allocate a byte array. */
     protected Payload() {
       // no-arg constructor since this class implements Serializable
     }
@@ -74,6 +80,9 @@
       this.length = length;
     }
     
+    /**
+     * Returns the length of the payload data. 
+     */
     public int length() {
       return this.length;
     }



Mime
View raw message