mirror of https://github.com/apache/lucene.git
LUCENE-917: Javadoc improvements for org.apache.lucene.index.Payload
git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@545693 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
994f083846
commit
53ef7398ce
|
@ -41,10 +41,16 @@ import org.apache.lucene.analysis.TokenStream;
|
||||||
*/
|
*/
|
||||||
// TODO: Remove warning after API has been finalized
|
// TODO: Remove warning after API has been finalized
|
||||||
public class Payload implements Serializable {
|
public class Payload implements Serializable {
|
||||||
|
/** the byte array containing the payload data */
|
||||||
protected byte[] data;
|
protected byte[] data;
|
||||||
|
|
||||||
|
/** the offset within the byte array */
|
||||||
protected int offset;
|
protected int offset;
|
||||||
|
|
||||||
|
/** the length of the payload data */
|
||||||
protected int length;
|
protected int length;
|
||||||
|
|
||||||
|
/** Creates an empty payload and does not allocate a byte array. */
|
||||||
protected Payload() {
|
protected Payload() {
|
||||||
// no-arg constructor since this class implements Serializable
|
// no-arg constructor since this class implements Serializable
|
||||||
}
|
}
|
||||||
|
@ -74,6 +80,9 @@ import org.apache.lucene.analysis.TokenStream;
|
||||||
this.length = length;
|
this.length = length;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the length of the payload data.
|
||||||
|
*/
|
||||||
public int length() {
|
public int length() {
|
||||||
return this.length;
|
return this.length;
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue