Apache/lucene
1
0
Fork 0
mirror of https://github.com/apache/lucene.git synced 2025-02-28 21:39:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

LUCENE-4424: fix see tags in DocValues.java

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1389748 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Simon Willnauer 2012-09-25 08:18:27 +00:00
parent dc1e036ef3
commit 321d5d22be
1 changed files with 25 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
lucene/core/src/java/org/apache/lucene/index/DocValues.java
View File

@ -60,20 +60,32 @@ import org.apache.lucene.util.packed.PackedInts;
* into a 3rd type like {@link Type#BYTES_VAR_STRAIGHT} to prevent data loss and merge exceptions.
* This behavior is considered <i>best-effort</i> might change in future releases.
* </p>
* <p>
* DocValues are exposed via the {@link Field} API with type safe
* specializations for each type variant:
* <ul>
* <li> {@link ByteDocValuesField} - for adding byte values to the index</li>
* <li> {@link ShortDocValuesField} - for adding short values to the index</li>
* <li> {@link IntDocValuesField} - for adding int values to the index</li>
* <li> {@link LongDocValuesField} - for adding long values to the index</li>
* <li> {@link FloatDocValuesField} - for adding float values to the index</li>
* <li> {@link DoubleDocValuesField} - for adding double values to the index</li>
* <li> {@link PackedLongDocValuesField} - for adding packed long values to the
* index</li>
* <li> {@link SortedBytesDocValuesField} - for adding sorted {@link BytesRef}
* values to the index</li>
* <li> {@link StraightBytesDocValuesField} - for adding straight
* {@link BytesRef} values to the index</li>
* <li> {@link DerefBytesDocValuesField} - for adding deref {@link BytesRef}
* values to the index</li>
* </ul>
* See also {@link Type} for limitations of each type variant.
* <p>
* <p>
*
* @see Type for limitations and default implementation documentation
* @see ByteDocValuesField for adding byte values to the index
* @see ShortDocValuesField for adding short values to the index
* @see IntDocValuesField for adding int values to the index
* @see LongDocValuesField for adding long values to the index
* @see FloatDocValuesField for adding float values to the index
* @see DoubleDocValuesField for adding double values to the index
* @see PackedLongDocValuesField for adding packed long values to the index
* @see SortedBytesDocValuesField for adding sorted {@link BytesRef} values to the index
* @see StraightBytesDocValuesField for adding straight {@link BytesRef} values to the index
* @see DerefBytesDocValuesField for adding deref {@link BytesRef} values to the index
* @see DocValuesFormat#docsConsumer(org.apache.lucene.index.PerDocWriteState) for
* customization
* @see DocValuesFormat#docsConsumer(org.apache.lucene.index.PerDocWriteState) Codec API for
* low level optimization and file format customization.
*
* @lucene.experimental
*/
public abstract class DocValues implements Closeable {