Return-Path: Delivered-To: apmail-lucene-java-commits-archive@www.apache.org Received: (qmail 25505 invoked from network); 9 Jun 2007 04:53:02 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 9 Jun 2007 04:53:02 -0000 Received: (qmail 70548 invoked by uid 500); 9 Jun 2007 04:53:06 -0000 Delivered-To: apmail-lucene-java-commits-archive@lucene.apache.org Received: (qmail 70528 invoked by uid 500); 9 Jun 2007 04:53:06 -0000 Mailing-List: contact java-commits-help@lucene.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: java-dev@lucene.apache.org Delivered-To: mailing list java-commits@lucene.apache.org Received: (qmail 70514 invoked by uid 99); 9 Jun 2007 04:53:06 -0000 Received: from herse.apache.org (HELO herse.apache.org) (140.211.11.133) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 08 Jun 2007 21:53:06 -0700 X-ASF-Spam-Status: No, hits=-99.5 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO eris.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 08 Jun 2007 21:53:02 -0700 Received: by eris.apache.org (Postfix, from userid 65534) id DC9D81A981A; Fri, 8 Jun 2007 21:52:41 -0700 (PDT) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit 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 -0000 To: java-commits@lucene.apache.org From: buschmi@apache.org X-Mailer: svnmailer-1.1.0 Message-Id: <20070609045241.DC9D81A981A@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org 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; }