LUCENE-8699: Add lucene internal tag to PointValue interface

and fix some typos
This commit is contained in:
iverase 2019-02-22 11:04:46 +01:00
parent 906a08838b
commit 9b8a4a9e6e
1 changed files with 7 additions and 6 deletions

View File

@ -19,18 +19,19 @@ package org.apache.lucene.util.bkd;
import org.apache.lucene.util.BytesRef; import org.apache.lucene.util.BytesRef;
/** /** Represents a dimensional point value written in the BKD tree.
* Represent a dimensional point value written in the BKD tree. *
*/ * @lucene.internal
**/
public interface PointValue { public interface PointValue {
/** Return the packed values for the dimensions */ /** Returns the packed values for the dimensions */
BytesRef packedValue(); BytesRef packedValue();
/** The document id */ /** Returns the document id */
int docID(); int docID();
/** The byte representation of the document id */ /** Returns the byte representation of the document id */
BytesRef docIDBytes(); BytesRef docIDBytes();
} }