Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LUCENE-3069: small javadoc fixes 

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/branches/lucene3069@1520422 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael McCandless 2013-09-05 20:58:17 +00:00
parent aa1e8b37f4
commit 0a8fc36864
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
lucene/core/src/java/org/apache/lucene/codecs/PostingsWriterBase.java
View File

@ -69,19 +69,20 @@ public abstract class PostingsWriterBase extends PostingsConsumer implements Clo
* current term is delta encoded according to latest term. * current term is delta encoded according to latest term.
* Usually elements in {@code longs} are file pointers, so each one always * Usually elements in {@code longs} are file pointers, so each one always
* increases when a new term is consumed. {@code out} is used to write generic * increases when a new term is consumed. {@code out} is used to write generic
* bytes, which are not monotonical. * bytes, which are not monotonic.
* *
* NOTE: sometimes long[] might contain values that doesn't make sense, e.g. * NOTE: sometimes long[] might contain "don't care" values that are unused, e.g.
* the pointer to postings list may not be defined, if it is designed to inline * the pointer to postings list may not be defined for some terms but is defined
* some postings data in term dictionary. For this the postings side should * for others, if it is designed to inline some postings data in term dictionary.
* always use the last file pointer, so that each element in metadata long[] is * In this case, the postings writer should always use the last value, so that each
* still monotonic. * element in metadata long[] remains monotonic.
*/ */
public abstract void encodeTerm(long[] longs, DataOutput out, FieldInfo fieldInfo, BlockTermState state, boolean absolute) throws IOException; public abstract void encodeTerm(long[] longs, DataOutput out, FieldInfo fieldInfo, BlockTermState state, boolean absolute) throws IOException;
/** /**
* Return the fixed length of long[] metadata (which is fixed per field), * Sets the current field for writing, and returns the
* called when the writing switches to another field. */ * fixed length of long[] metadata (which is fixed per
* field), called when the writing switches to another field. */
// TODO: better name? // TODO: better name?
public abstract int setField(FieldInfo fieldInfo); public abstract int setField(FieldInfo fieldInfo);