mirror of https://github.com/apache/lucene.git
LUCENE-2209: add @lucene.internal/@lucene.experimental javadoc tags
git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@905057 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
869c789563
commit
39b9f97cd4
|
@ -633,8 +633,10 @@
|
|||
doctitle="@{title}"
|
||||
maxmemory="${javadoc.maxmemory}"
|
||||
bottom="Copyright © ${year} Apache Software Foundation. All Rights Reserved.">
|
||||
<tag name="todo" description="To Do:"/>
|
||||
<tag name="uml.property" description="UML Property:"/>
|
||||
<tag name="lucene.experimental"
|
||||
description="WARNING: This API is experimental and might change in incompatible ways in the next release."/>
|
||||
<tag name="lucene.internal"
|
||||
description="NOTE: This API is for Lucene internal purposes only and might change in incompatible ways in the next release."/>
|
||||
<link offline="true" packagelistLoc="${javadoc.dir}"/>
|
||||
|
||||
<sources />
|
||||
|
|
|
@ -27,12 +27,7 @@ import java.util.Properties;
|
|||
* <p>
|
||||
* SmartChineseAnalyzer has a built-in dictionary and stopword list out-of-box.
|
||||
* </p>
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental.
|
||||
* The APIs and file formats introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* </p>
|
||||
*
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public class AnalyzerProfile {
|
||||
|
||||
|
|
|
@ -19,11 +19,7 @@ package org.apache.lucene.analysis.cn.smart;
|
|||
|
||||
/**
|
||||
* Internal SmartChineseAnalyzer character type constants.
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental.
|
||||
* The APIs and file formats introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public class CharType {
|
||||
|
||||
|
|
|
@ -31,11 +31,7 @@ import org.apache.lucene.util.AttributeSource;
|
|||
* <p>
|
||||
* The output tokens can then be broken into words with {@link WordTokenFilter}
|
||||
* </p>
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental.
|
||||
* The APIs and file formats introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public final class SentenceTokenizer extends Tokenizer {
|
||||
|
||||
|
|
|
@ -52,11 +52,7 @@ import org.apache.lucene.util.Version;
|
|||
* The included dictionary data is from <a href="http://www.ictclas.org">ICTCLAS1.0</a>.
|
||||
* Thanks to ICTCLAS for their hard work, and for contributing the data under the Apache 2 License!
|
||||
* </p>
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental.
|
||||
* The APIs and file formats introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public final class SmartChineseAnalyzer extends Analyzer {
|
||||
|
||||
|
|
|
@ -21,11 +21,7 @@ import org.apache.lucene.analysis.cn.smart.hhmm.SegTokenFilter; // for javadoc
|
|||
|
||||
/**
|
||||
* SmartChineseAnalyzer utility constants and methods
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental.
|
||||
* The APIs and file formats introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public class Utility {
|
||||
|
||||
|
|
|
@ -26,11 +26,7 @@ import org.apache.lucene.analysis.cn.smart.hhmm.SegTokenFilter;
|
|||
|
||||
/**
|
||||
* Segment a sentence of Chinese text into words.
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental.
|
||||
* The APIs and file formats introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
class WordSegmenter {
|
||||
|
||||
|
|
|
@ -30,11 +30,7 @@ import org.apache.lucene.analysis.tokenattributes.TypeAttribute;
|
|||
|
||||
/**
|
||||
* A {@link TokenFilter} that breaks sentences into words.
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental.
|
||||
* The APIs and file formats introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public final class WordTokenFilter extends TokenFilter {
|
||||
|
||||
|
|
|
@ -19,11 +19,7 @@ package org.apache.lucene.analysis.cn.smart;
|
|||
|
||||
/**
|
||||
* Internal SmartChineseAnalyzer token type constants
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental.
|
||||
* The APIs and file formats introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public class WordType {
|
||||
|
||||
|
|
|
@ -26,11 +26,7 @@ import java.io.UnsupportedEncodingException;
|
|||
* <p>
|
||||
* Contains methods for dealing with GB2312 encoding.
|
||||
* </p>
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental.
|
||||
* The APIs and file formats introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
abstract class AbstractDictionary {
|
||||
/**
|
||||
|
|
|
@ -30,11 +30,7 @@ import org.apache.lucene.analysis.cn.smart.Utility;
|
|||
* <p>
|
||||
* For each start offset, a list of possible token pairs is stored.
|
||||
* </p>
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental.
|
||||
* The APIs and file formats introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
class BiSegGraph {
|
||||
|
||||
|
|
|
@ -34,11 +34,7 @@ import org.apache.lucene.analysis.cn.smart.AnalyzerProfile;
|
|||
|
||||
/**
|
||||
* SmartChineseAnalyzer Bigram dictionary.
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental.
|
||||
* The APIs and file formats introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
class BigramDictionary extends AbstractDictionary {
|
||||
|
||||
|
|
|
@ -26,11 +26,7 @@ import org.apache.lucene.analysis.cn.smart.hhmm.SegToken;//javadoc @link
|
|||
|
||||
/**
|
||||
* Finds the optimal segmentation of a sentence into Chinese words
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental.
|
||||
* The APIs and file formats introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public class HHMMSegmenter {
|
||||
|
||||
|
|
|
@ -22,11 +22,7 @@ package org.apache.lucene.analysis.cn.smart.hhmm;
|
|||
* <p>
|
||||
* Used by {@link BiSegGraph} to maximize the segmentation with the Viterbi algorithm.
|
||||
* </p>
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental.
|
||||
* The APIs and file formats introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
class PathNode implements Comparable<PathNode> {
|
||||
public double weight;
|
||||
|
|
|
@ -27,11 +27,7 @@ import java.util.Map;
|
|||
* <p>
|
||||
* For each start offset, a list of possible tokens is stored.
|
||||
* </p>
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental.
|
||||
* The APIs and file formats introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
class SegGraph {
|
||||
|
||||
|
|
|
@ -23,11 +23,7 @@ import org.apache.lucene.analysis.cn.smart.WordType; // for javadocs
|
|||
|
||||
/**
|
||||
* SmartChineseAnalyzer internal token
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental.
|
||||
* The APIs and file formats introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public class SegToken {
|
||||
/**
|
||||
|
|
|
@ -25,11 +25,7 @@ import org.apache.lucene.analysis.cn.smart.WordType;
|
|||
* Filters a {@link SegToken} by converting full-width latin to half-width, then lowercasing latin.
|
||||
* Additionally, all punctuation is converted into {@link Utility#COMMON_DELIMITER}
|
||||
* </p>
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental.
|
||||
* The APIs and file formats introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public class SegTokenFilter {
|
||||
|
||||
|
|
|
@ -21,11 +21,7 @@ import java.util.Arrays;
|
|||
|
||||
/**
|
||||
* A pair of tokens in {@link SegGraph}
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental.
|
||||
* The APIs and file formats introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
class SegTokenPair {
|
||||
|
||||
|
|
|
@ -35,12 +35,7 @@ import org.apache.lucene.analysis.cn.smart.Utility;
|
|||
|
||||
/**
|
||||
* SmartChineseAnalyzer Word Dictionary
|
||||
*
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental.
|
||||
* The APIs and file formats introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
class WordDictionary extends AbstractDictionary {
|
||||
|
||||
|
|
|
@ -23,11 +23,7 @@
|
|||
SmartChineseAnalyzer Hidden Markov Model package.
|
||||
</div>
|
||||
<div>
|
||||
<font color="#FF0000">
|
||||
WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental. The APIs
|
||||
and file formats introduced here might change in the future and will not be supported anymore
|
||||
in such a case.
|
||||
</font>
|
||||
@lucene.experimental
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
@ -24,11 +24,7 @@
|
|||
Analyzer for Simplified Chinese, which indexes words.
|
||||
</div>
|
||||
<div>
|
||||
<font color="#FF0000">
|
||||
WARNING: The status of the analyzers/smartcn <b>analysis.cn.smart</b> package is experimental. The APIs
|
||||
and file formats introduced here might change in the future and will not be supported anymore
|
||||
in such a case.
|
||||
</font>
|
||||
@lucene.experimental
|
||||
</div>
|
||||
<div>
|
||||
Three analyzers are provided for Chinese, each of which treats Chinese text in a different way.
|
||||
|
|
|
@ -89,7 +89,7 @@ public class TextDocument {
|
|||
|
||||
/**
|
||||
*@return The contents value
|
||||
*@todo finish this method
|
||||
*TODO: finish this method
|
||||
*/
|
||||
public String getContents() {
|
||||
return contents;
|
||||
|
|
|
@ -29,8 +29,7 @@ import org.apache.lucene.util.ArrayUtil;
|
|||
* single query (body: 1) sorted by docdate, and prints
|
||||
* time to reopen and time to run the search.
|
||||
*
|
||||
* <b>NOTE</b>: this is very experimental at this point, and
|
||||
* subject to change. It's also not generally usable, eg
|
||||
* @lucene.experimental It's also not generally usable, eg
|
||||
* you cannot change which query is executed.
|
||||
*/
|
||||
public class NearRealtimeReaderTask extends PerfTask {
|
||||
|
|
|
@ -43,7 +43,7 @@ import org.apache.lucene.util.BitVector;
|
|||
* results up to a 100 times faster than the file-centric RAMDirectory
|
||||
* at the cost of greater RAM consumption.
|
||||
* <p>
|
||||
* WARNING: This contrib is experimental and the APIs may change without warning.
|
||||
* @lucene.experimental
|
||||
* <p>
|
||||
* There are no read and write locks in this store.
|
||||
* {@link InstantiatedIndexReader} {@link InstantiatedIndexReader#isCurrent()} all the time
|
||||
|
|
|
@ -22,7 +22,7 @@
|
|||
<body>
|
||||
<p>InstantiatedIndex, alternative RAM store for small corpora.</p>
|
||||
|
||||
<p>WARNING: This contrib is experimental and the APIs may change without warning.</p>
|
||||
<p>@lucene.experimental</p>
|
||||
<h2>Abstract</h2>
|
||||
|
||||
<p>
|
||||
|
|
|
@ -41,8 +41,7 @@ import org.apache.lucene.store.FSDirectory;
|
|||
* File{In,Out}putStream) so it will not work with non
|
||||
* FSDirectory Directory impls.</p>
|
||||
*
|
||||
* <p><b>NOTE</b>: The tool is experimental and might change
|
||||
* in incompatible ways in the next release. You can easily
|
||||
* @lucene.experimental You can easily
|
||||
* accidentally remove segments from your index so be
|
||||
* careful!
|
||||
*/
|
||||
|
|
|
@ -36,8 +36,7 @@ import java.util.*;
|
|||
* Wikipedia tutorial available at http://en.wikipedia.org/wiki/Wikipedia:Tutorial, but it may not be complete.
|
||||
* <p/>
|
||||
* <p/>
|
||||
* EXPERIMENTAL !!!!!!!!!
|
||||
* NOTE: This Tokenizer is considered experimental and the grammar is subject to change in the trunk and in follow up releases.
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public final class WikipediaTokenizer extends Tokenizer {
|
||||
public static final String INTERNAL_LINK = "il";
|
||||
|
|
|
@ -82,8 +82,7 @@ import org.apache.lucene.analysis.tokenattributes.PositionIncrementAttribute;
|
|||
* href="../search/NumericRangeQuery.html#precisionStepDesc"><code>precisionStep</code></a>
|
||||
* parameter as well as how numeric fields work under the hood.</p>
|
||||
*
|
||||
* <p><font color="red"><b>NOTE:</b> This API is experimental and
|
||||
* might change in incompatible ways in the next release.</font>
|
||||
* @lucene.experimental
|
||||
*
|
||||
* @since 2.9
|
||||
*/
|
||||
|
|
|
@ -454,14 +454,14 @@ public class Token extends AttributeImpl
|
|||
}
|
||||
|
||||
/**
|
||||
* EXPERIMENTAL: While we think this is here to stay, we may want to change it to be a long.
|
||||
* <p/>
|
||||
*
|
||||
* Get the bitset for any bits that have been set. This is completely distinct from {@link #type()}, although they do share similar purposes.
|
||||
* The flags can be used to encode information about the token for use by other {@link org.apache.lucene.analysis.TokenFilter}s.
|
||||
*
|
||||
*
|
||||
*
|
||||
* @return The bits
|
||||
* @lucene.experimental While we think this is here to stay, we may want to change it to be a long.
|
||||
*/
|
||||
public int getFlags() {
|
||||
return flags;
|
||||
|
|
|
@ -23,10 +23,10 @@ import org.apache.lucene.util.Attribute;
|
|||
/**
|
||||
* This attribute can be used to pass different flags down the {@link Tokenizer} chain,
|
||||
* eg from one TokenFilter to another one.
|
||||
* @lucene.experimental While we think this is here to stay, we may want to change it to be a long.
|
||||
*/
|
||||
public interface FlagsAttribute extends Attribute {
|
||||
/**
|
||||
* EXPERIMENTAL: While we think this is here to stay, we may want to change it to be a long.
|
||||
* <p/>
|
||||
*
|
||||
* Get the bitset for any bits that have been set. This is completely distinct from {@link TypeAttribute#type()}, although they do share similar purposes.
|
||||
|
|
|
@ -24,12 +24,12 @@ import org.apache.lucene.util.AttributeImpl;
|
|||
/**
|
||||
* This attribute can be used to pass different flags down the tokenizer chain,
|
||||
* eg from one TokenFilter to another one.
|
||||
* @lucene.experimental While we think this is here to stay, we may want to change it to be a long.
|
||||
*/
|
||||
public class FlagsAttributeImpl extends AttributeImpl implements FlagsAttribute, Cloneable, Serializable {
|
||||
private int flags = 0;
|
||||
|
||||
/**
|
||||
* EXPERIMENTAL: While we think this is here to stay, we may want to change it to be a long.
|
||||
* <p/>
|
||||
*
|
||||
* Get the bitset for any bits that have been set. This is completely distinct from {@link TypeAttribute#type()}, although they do share similar purposes.
|
||||
|
|
|
@ -134,9 +134,7 @@ import org.apache.lucene.search.FieldCache; // javadocs
|
|||
* values are returned as {@link String}s (according to
|
||||
* <code>toString(value)</code> of the used data type).
|
||||
*
|
||||
* <p><font color="red"><b>NOTE:</b> This API is
|
||||
* experimental and might change in incompatible ways in the
|
||||
* next release.</font>
|
||||
* @lucene.experimental
|
||||
*
|
||||
* @since 2.9
|
||||
*/
|
||||
|
|
|
@ -41,9 +41,7 @@ import java.util.Map;
|
|||
* <p>As this tool checks every byte in the index, on a large
|
||||
* index it can take quite a long time to run.
|
||||
*
|
||||
* <p><b>WARNING</b>: this tool and API is new and
|
||||
* experimental and is subject to suddenly change in the
|
||||
* next release. Please make a complete backup of your
|
||||
* @lucene.experimental Please make a complete backup of your
|
||||
* index before using this to fix your index!
|
||||
*/
|
||||
public class CheckIndex {
|
||||
|
@ -54,8 +52,7 @@ public class CheckIndex {
|
|||
/**
|
||||
* Returned from {@link #checkIndex()} detailing the health and status of the index.
|
||||
*
|
||||
* <p><b>WARNING</b>: this API is new and experimental and is
|
||||
* subject to suddenly change in the next release.
|
||||
* @lucene.experimental
|
||||
**/
|
||||
|
||||
public static class Status {
|
||||
|
|
|
@ -925,7 +925,7 @@ class DirectoryReader extends IndexReader implements Cloneable {
|
|||
/**
|
||||
* Expert: return the IndexCommit that this reader has opened.
|
||||
* <p/>
|
||||
* <p><b>WARNING</b>: this API is new and experimental and may suddenly change.</p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
@Override
|
||||
public IndexCommit getIndexCommit() throws IOException {
|
||||
|
|
|
@ -23,8 +23,7 @@ import org.apache.lucene.util.AttributeSource;
|
|||
* being added to the index. The information collected in this class is
|
||||
* also used to calculate the normalization factor for a field.
|
||||
*
|
||||
* <p><b>WARNING</b>: This API is new and experimental, and may suddenly
|
||||
* change.</p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public final class FieldInvertState {
|
||||
int position;
|
||||
|
|
|
@ -20,7 +20,7 @@ package org.apache.lucene.index;
|
|||
import java.io.IOException;
|
||||
|
||||
/**
|
||||
* NOTE: this API is experimental and will likely change
|
||||
* @lucene.experimental
|
||||
*/
|
||||
|
||||
abstract class FormatPostingsDocsConsumer {
|
||||
|
|
|
@ -24,7 +24,7 @@ import java.io.IOException;
|
|||
* actually do "something" with the postings (write it into
|
||||
* the index in a specific format).
|
||||
*
|
||||
* NOTE: this API is experimental and will likely change
|
||||
* @lucene.experimental
|
||||
*/
|
||||
abstract class FormatPostingsFieldsConsumer {
|
||||
|
||||
|
|
|
@ -23,7 +23,7 @@ import org.apache.lucene.util.ArrayUtil;
|
|||
import org.apache.lucene.util.RamUsageEstimator;
|
||||
|
||||
/**
|
||||
* NOTE: this API is experimental and will likely change
|
||||
* @lucene.experimental
|
||||
*/
|
||||
|
||||
abstract class FormatPostingsTermsConsumer {
|
||||
|
|
|
@ -37,8 +37,7 @@ import org.apache.lucene.store.Directory;
|
|||
* associated with it. The segments file associated with a
|
||||
* later index commit point would have a larger N.</p>
|
||||
*
|
||||
* <p><b>WARNING</b>: This API is a new and experimental and
|
||||
* may suddenly change. </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
|
||||
public abstract class IndexCommit {
|
||||
|
|
|
@ -1053,8 +1053,7 @@ public abstract class IndexReader implements Cloneable,Closeable {
|
|||
* readers that correspond to a Directory with its own
|
||||
* segments_N file.
|
||||
*
|
||||
* <p><b>WARNING</b>: this API is new and experimental and
|
||||
* may suddenly change.</p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public IndexCommit getIndexCommit() throws IOException {
|
||||
throw new UnsupportedOperationException("This reader does not support this method.");
|
||||
|
|
|
@ -360,8 +360,7 @@ public class IndexWriter implements Closeable {
|
|||
* if you attempt to reopen any of those readers, you'll
|
||||
* hit an {@link AlreadyClosedException}.</p>
|
||||
*
|
||||
* <p><b>NOTE:</b> This API is experimental and might
|
||||
* change in incompatible ways in the next release.</p>
|
||||
* @lucene.experimental
|
||||
*
|
||||
* @return IndexReader that covers entire index plus all
|
||||
* changes made so far by this IndexWriter instance
|
||||
|
@ -4825,8 +4824,7 @@ public class IndexWriter implements Closeable {
|
|||
* search, but will reduce search latency on opening a
|
||||
* new near real-time reader after a merge completes.
|
||||
*
|
||||
* <p><b>NOTE:</b> This API is experimental and might
|
||||
* change in incompatible ways in the next release.</p>
|
||||
* @lucene.experimental
|
||||
*
|
||||
* <p><b>NOTE</b>: warm is called before any deletes have
|
||||
* been carried over to the merged segment. */
|
||||
|
|
|
@ -51,8 +51,7 @@ import java.util.Set;
|
|||
* <p>The default MergePolicy is {@link
|
||||
* LogByteSizeMergePolicy}.</p>
|
||||
*
|
||||
* <p><b>NOTE:</b> This API is new and still experimental
|
||||
* (subject to change suddenly in the next release)</p>
|
||||
* @lucene.experimental
|
||||
*
|
||||
* <p><b>NOTE</b>: This class typically requires access to
|
||||
* package-private APIs (e.g. <code>SegmentInfos</code>) to do its job;
|
||||
|
|
|
@ -24,8 +24,7 @@ import java.io.IOException;
|
|||
* selected by a {@link MergePolicy}. The default
|
||||
* MergeScheduler is {@link ConcurrentMergeScheduler}.</p>
|
||||
*
|
||||
* <p><b>NOTE:</b> This API is new and still experimental
|
||||
* (subject to change suddenly in the next release)</p>
|
||||
* @lucene.experimental
|
||||
*
|
||||
* <p><b>NOTE</b>: This class typically requires access to
|
||||
* package-private APIs (eg, SegmentInfos) to do its job;
|
||||
|
|
|
@ -32,8 +32,7 @@ import java.util.Collections;
|
|||
* Information about a segment such as it's name, directory, and files related
|
||||
* to the segment.
|
||||
*
|
||||
* * <p><b>NOTE:</b> This API is new and still experimental
|
||||
* (subject to change suddenly in the next release)</p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public final class SegmentInfo {
|
||||
|
||||
|
|
|
@ -40,8 +40,7 @@ import java.util.Map;
|
|||
* A collection of segmentInfo objects with methods for operating on
|
||||
* those segments in relation to the file system.
|
||||
*
|
||||
* <p><b>NOTE:</b> This API is new and still experimental
|
||||
* (subject to change suddenly in the next release)</p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public final class SegmentInfos extends Vector<SegmentInfo> {
|
||||
|
||||
|
|
|
@ -41,8 +41,7 @@ import org.apache.lucene.util.CloseableThreadLocal;
|
|||
import org.apache.lucene.search.FieldCache; // not great (circular); used only to purge FieldCache entry on close
|
||||
|
||||
/**
|
||||
* <p><b>NOTE:</b> This API is new and still experimental
|
||||
* (subject to change suddenly in the next release)</p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public class SegmentReader extends IndexReader implements Cloneable {
|
||||
protected boolean readOnly;
|
||||
|
|
|
@ -39,8 +39,7 @@ import org.apache.lucene.store.Directory;
|
|||
* snapshot held when a writer is closed will "survive"
|
||||
* when the next writer is opened.
|
||||
*
|
||||
* <p><b>WARNING</b>: This API is a new and experimental and
|
||||
* may suddenly change.</p> */
|
||||
* @lucene.experimental */
|
||||
|
||||
public class SnapshotDeletionPolicy implements IndexDeletionPolicy {
|
||||
|
||||
|
|
|
@ -116,8 +116,7 @@ import org.apache.lucene.index.IndexReader;
|
|||
* you need that behavior, use {@link
|
||||
* PositiveScoresOnlyCollector}.</p>
|
||||
*
|
||||
* <p><b>NOTE:</b> This API is experimental and might change
|
||||
* in incompatible ways in the next release.</p>
|
||||
* @lucene.experimental
|
||||
*
|
||||
* @since 2.9
|
||||
*/
|
||||
|
|
|
@ -29,8 +29,7 @@ public class DefaultSimilarity extends Similarity {
|
|||
* FieldInvertState#getLength()} - {@link
|
||||
* FieldInvertState#getNumOverlap()}.
|
||||
*
|
||||
* <p><b>WARNING</b>: This API is new and experimental, and may suddenly
|
||||
* change.</p> */
|
||||
* @lucene.experimental */
|
||||
@Override
|
||||
public float computeNorm(String field, FieldInvertState state) {
|
||||
final int numTerms;
|
||||
|
@ -85,8 +84,7 @@ public class DefaultSimilarity extends Similarity {
|
|||
* norm. By default this is false, meaning overlap
|
||||
* tokens are counted just like non-overlap tokens.
|
||||
*
|
||||
* <p><b>WARNING</b>: This API is new and experimental, and may suddenly
|
||||
* change.</p>
|
||||
* @lucene.experimental
|
||||
*
|
||||
* @see #computeNorm
|
||||
*/
|
||||
|
|
|
@ -496,12 +496,7 @@ public interface FieldCache {
|
|||
/**
|
||||
* EXPERT: A unique Identifier/Description for each item in the FieldCache.
|
||||
* Can be useful for logging/debugging.
|
||||
* <p>
|
||||
* <b>EXPERIMENTAL API:</b> This API is considered extremely advanced
|
||||
* and experimental. It may be removed or altered w/o warning in future
|
||||
* releases
|
||||
* of Lucene.
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public static abstract class CacheEntry {
|
||||
public abstract Object getReaderKey();
|
||||
|
@ -566,12 +561,7 @@ public interface FieldCache {
|
|||
* associated with it has garbage collected will prevent the Value itself
|
||||
* from being garbage collected when the Cache drops the WeakReference.
|
||||
* </p>
|
||||
* <p>
|
||||
* <b>EXPERIMENTAL API:</b> This API is considered extremely advanced
|
||||
* and experimental. It may be removed or altered w/o warning in future
|
||||
* releases
|
||||
* of Lucene.
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public abstract CacheEntry[] getCacheEntries();
|
||||
|
||||
|
@ -584,12 +574,7 @@ public interface FieldCache {
|
|||
* It should not be relied on for "Cache maintenance" in general
|
||||
* application code.
|
||||
* </p>
|
||||
* <p>
|
||||
* <b>EXPERIMENTAL API:</b> This API is considered extremely advanced
|
||||
* and experimental. It may be removed or altered w/o warning in future
|
||||
* releases
|
||||
* of Lucene.
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public abstract void purgeAllCaches();
|
||||
|
||||
|
|
|
@ -79,8 +79,7 @@ import org.apache.lucene.search.FieldCache.StringIndex;
|
|||
* FieldDoc#fields} when returning the top results.
|
||||
* </ul>
|
||||
*
|
||||
* <b>NOTE:</b> This API is experimental and might change in
|
||||
* incompatible ways in the next release.
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public abstract class FieldComparator {
|
||||
|
||||
|
|
|
@ -23,8 +23,7 @@ import java.io.Serializable;
|
|||
/**
|
||||
* Provides a {@link FieldComparator} for custom field sorting.
|
||||
*
|
||||
* <b>NOTE:</b> This API is experimental and might change in
|
||||
* incompatible ways in the next release.
|
||||
* @lucene.experimental
|
||||
*
|
||||
*/
|
||||
public abstract class FieldComparatorSource implements Serializable {
|
||||
|
|
|
@ -26,9 +26,7 @@ import org.apache.lucene.util.PriorityQueue;
|
|||
* Uses <code>FieldCache.DEFAULT</code> for maintaining
|
||||
* internal term lookup tables.
|
||||
*
|
||||
* <b>NOTE:</b> This API is experimental and might change in
|
||||
* incompatible ways in the next release.
|
||||
*
|
||||
* @lucene.experimental
|
||||
* @since 2.9
|
||||
* @see Searcher#search(Query,Filter,int,Sort)
|
||||
* @see FieldCache
|
||||
|
|
|
@ -86,9 +86,7 @@ public class IndexSearcher extends Searcher {
|
|||
/** Expert: directly specify the reader, subReaders and
|
||||
* their docID starts.
|
||||
*
|
||||
* <p><b>NOTE:</b> This API is experimental and
|
||||
* might change in incompatible ways in the next
|
||||
* release.</font></p> */
|
||||
* @lucene.experimental */
|
||||
public IndexSearcher(IndexReader reader, IndexReader[] subReaders, int[] docStarts) {
|
||||
this.reader = reader;
|
||||
this.subReaders = subReaders;
|
||||
|
|
|
@ -39,9 +39,7 @@ import org.apache.lucene.util.NumericUtils; // for javadocs
|
|||
* See {@link NumericRangeQuery} for details on how Lucene
|
||||
* indexes and searches numeric valued fields.
|
||||
*
|
||||
* <p><font color="red"><b>NOTE:</b> This API is experimental and
|
||||
* might change in incompatible ways in the next
|
||||
* release.</font>
|
||||
* @lucene.experimental
|
||||
*
|
||||
* @since 2.9
|
||||
**/
|
||||
|
|
|
@ -75,8 +75,7 @@ import org.apache.lucene.index.TermEnum;
|
|||
* BooleanQuery rewrite methods without changing
|
||||
* BooleanQuery's default max clause count.
|
||||
*
|
||||
* <p><font color="red"><b>NOTE:</b> This API is experimental and
|
||||
* might change in incompatible ways in the next release.</font>
|
||||
* @lucene.experimental
|
||||
*
|
||||
* <br><h3>How it works</h3>
|
||||
*
|
||||
|
|
|
@ -602,8 +602,7 @@ public abstract class Similarity implements Serializable {
|
|||
* {@link FieldInvertState#getLength()} as the second argument, and
|
||||
* then multiplies this value by {@link FieldInvertState#getBoost()}.</p>
|
||||
*
|
||||
* <p><b>WARNING</b>: This API is new and experimental and may
|
||||
* suddenly change.</p>
|
||||
* @lucene.experimental
|
||||
*
|
||||
* @param field field name
|
||||
* @param state current processing state for this field
|
||||
|
|
|
@ -365,8 +365,7 @@ implements Serializable {
|
|||
/** Returns the {@link FieldComparator} to use for
|
||||
* sorting.
|
||||
*
|
||||
* <b>NOTE:</b> This API is experimental and might change in
|
||||
* incompatible ways in the next release.
|
||||
* @lucene.experimental
|
||||
*
|
||||
* @param numHits number of top hits the queue will store
|
||||
* @param sortPos position of this SortField within {@link
|
||||
|
|
|
@ -23,8 +23,7 @@ import java.util.List;
|
|||
/**
|
||||
* The results of a SpanQueryFilter. Wraps the BitSet and the position information from the SpanQuery
|
||||
*
|
||||
*<p/>
|
||||
* NOTE: This API is still experimental and subject to change.
|
||||
* @lucene.experimental
|
||||
*
|
||||
**/
|
||||
public class SpanFilterResult {
|
||||
|
|
|
@ -30,8 +30,7 @@ import org.apache.lucene.util.PriorityQueue;
|
|||
* See the {@link #create(org.apache.lucene.search.Sort, int, boolean, boolean, boolean, boolean)} method
|
||||
* for instantiating a TopFieldCollector.
|
||||
*
|
||||
* <p><b>NOTE:</b> This API is experimental and might change in
|
||||
* incompatible ways in the next release.</p>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public abstract class TopFieldCollector extends TopDocsCollector<Entry> {
|
||||
|
||||
|
|
|
@ -29,10 +29,7 @@ import java.io.IOException;
|
|||
* using <code>getBytes()</code> and makes those values
|
||||
* available as other numeric types, casting as needed.
|
||||
*
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the <b>search.function</b> package is experimental.
|
||||
* The APIs introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* @lucene.experimental
|
||||
*
|
||||
* @see org.apache.lucene.search.function.FieldCacheSource for requirements
|
||||
* on the field.
|
||||
|
|
|
@ -42,10 +42,7 @@ import org.apache.lucene.util.ToStringUtils;
|
|||
* </ol>
|
||||
* Subclasses can modify the computation by overriding {@link #customScore(int, float, float)}.
|
||||
*
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the <b>search.function</b> package is experimental.
|
||||
* The APIs introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public class CustomScoreQuery extends Query {
|
||||
|
||||
|
|
|
@ -25,10 +25,7 @@ import org.apache.lucene.search.Explanation;
|
|||
* {@link org.apache.lucene.search.function.ValueSource ValueSuorce}
|
||||
* for a particular field and reader.
|
||||
*
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the <b>search.function</b> package is experimental.
|
||||
* The APIs introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* @lucene.experimental
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
|
|
@ -34,10 +34,7 @@ import org.apache.lucene.search.FieldCache;
|
|||
* <p>
|
||||
* Document with no tokens in this field are assigned the <code>Zero</code> value.
|
||||
*
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the <b>search.function</b> package is experimental.
|
||||
* The APIs introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* @lucene.experimental
|
||||
*
|
||||
* <p><b>NOTE</b>: with the switch in 2.9 to segment-based
|
||||
* searching, if {@link #getValues} is invoked with a
|
||||
|
|
|
@ -52,10 +52,7 @@ package org.apache.lucene.search.function;
|
|||
* otherwise, for instance if for each query a new index reader is opened, large penalties would be
|
||||
* paid for loading the field values into memory over and over again!
|
||||
*
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the <b>search.function</b> package is experimental.
|
||||
* The APIs introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public class FieldScoreQuery extends ValueSourceQuery {
|
||||
|
||||
|
|
|
@ -29,10 +29,7 @@ import java.io.IOException;
|
|||
* using <code>getFloats()</code> and makes those values
|
||||
* available as other numeric types, casting as needed.
|
||||
*
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the <b>search.function</b> package is experimental.
|
||||
* The APIs introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* @lucene.experimental
|
||||
*
|
||||
* @see org.apache.lucene.search.function.FieldCacheSource for requirements
|
||||
* on the field.
|
||||
|
|
|
@ -29,10 +29,7 @@ import java.io.IOException;
|
|||
* using <code>getInts()</code> and makes those values
|
||||
* available as other numeric types, casting as needed.
|
||||
*
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the <b>search.function</b> package is experimental.
|
||||
* The APIs introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* @lucene.experimental
|
||||
*
|
||||
* @see org.apache.lucene.search.function.FieldCacheSource for requirements
|
||||
* on the field.
|
||||
|
|
|
@ -39,10 +39,7 @@ import java.io.IOException;
|
|||
* when other documents are inserted or deleted,
|
||||
* or if a MultiSearcher is used.
|
||||
*
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the <b>search.function</b> package is experimental.
|
||||
* The APIs introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* @lucene.experimental
|
||||
*
|
||||
* <p><b>NOTE</b>: with the switch in 2.9 to segment-based
|
||||
* searching, if {@link #getValues} is invoked with a
|
||||
|
|
|
@ -40,10 +40,7 @@ import java.io.IOException;
|
|||
* when other documents are inserted or deleted,
|
||||
* or if a MultiSearcher is used.
|
||||
*
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the <b>search.function</b> package is experimental.
|
||||
* The APIs introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* @lucene.experimental
|
||||
*
|
||||
* <p><b>NOTE</b>: with the switch in 2.9 to segment-based
|
||||
* searching, if {@link #getValues} is invoked with a
|
||||
|
|
|
@ -29,10 +29,7 @@ import java.io.IOException;
|
|||
* using <code>getShorts()</code> and makes those values
|
||||
* available as other numeric types, casting as needed.
|
||||
*
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the <b>search.function</b> package is experimental.
|
||||
* The APIs introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* @lucene.experimental
|
||||
*
|
||||
* @see org.apache.lucene.search.function.FieldCacheSource for requirements
|
||||
* on the field.
|
||||
|
|
|
@ -31,10 +31,7 @@ import java.io.Serializable;
|
|||
* <P>ValueSource implementations differ in RAM requirements: it would always be a factor
|
||||
* of the number of documents, but for each document the number of bytes can be 1, 2, 4, or 8.
|
||||
*
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the <b>search.function</b> package is experimental.
|
||||
* The APIs introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* @lucene.experimental
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
|
|
@ -37,10 +37,7 @@ import java.util.Set;
|
|||
* <p>
|
||||
* Score is set as: Score(doc,query) = query.getBoost()<sup>2</sup> * valueSource(doc).
|
||||
*
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the <b>search.function</b> package is experimental.
|
||||
* The APIs introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public class ValueSourceQuery extends Query {
|
||||
ValueSource valSrc;
|
||||
|
|
|
@ -26,11 +26,7 @@
|
|||
The <code>function</code> package provides tight control over documents scores.
|
||||
</DIV>
|
||||
<DIV>
|
||||
<font color="#FF0000">
|
||||
WARNING: The status of the <b>search.function</b> package is experimental. The APIs
|
||||
introduced here might change in the future and will not be supported anymore
|
||||
in such a case.
|
||||
</font>
|
||||
@lucene.experimental
|
||||
</DIV>
|
||||
<DIV>
|
||||
Two types of queries are available in this package:
|
||||
|
|
|
@ -18,16 +18,15 @@ package org.apache.lucene.search.payloads;
|
|||
|
||||
import java.io.Serializable;
|
||||
|
||||
|
||||
/**
|
||||
* An abstract class that defines a way for Payload*Query instances
|
||||
* to transform the cumulative effects of payload scores for a document.
|
||||
*
|
||||
* An abstract class that defines a way for Payload*Query instances to transform
|
||||
* the cumulative effects of payload scores for a document.
|
||||
*
|
||||
* @see org.apache.lucene.search.payloads.PayloadTermQuery for more information
|
||||
*
|
||||
* <p/>
|
||||
* This class and its derivations are experimental and subject to change
|
||||
*
|
||||
*
|
||||
* @lucene.experimental This class and its derivations are experimental and subject to
|
||||
* change
|
||||
*
|
||||
**/
|
||||
public abstract class PayloadFunction implements Serializable {
|
||||
|
||||
|
|
|
@ -44,11 +44,7 @@ import org.apache.lucene.search.spans.Spans;
|
|||
* Operates like Highlighter - IndexReader should only contain doc of interest,
|
||||
* best to use MemoryIndex.
|
||||
*
|
||||
* <p/>
|
||||
* <font color="#FF0000">
|
||||
* WARNING: The status of the <b>Payloads</b> feature is experimental.
|
||||
* The APIs introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* @lucene.experimental
|
||||
*
|
||||
*/
|
||||
public class PayloadSpanUtil {
|
||||
|
|
|
@ -66,10 +66,7 @@ public abstract class Spans {
|
|||
* <br>
|
||||
* Note that the return type is a collection, thus the ordering should not be relied upon.
|
||||
* <br/>
|
||||
* <p><font color="#FF0000">
|
||||
* WARNING: The status of the <b>Payloads</b> feature is experimental.
|
||||
* The APIs introduced here might change in the future and will not be
|
||||
* supported anymore in such a case.</font>
|
||||
* @lucene.experimental
|
||||
*
|
||||
* @return a List of byte arrays containing the data of this payload, otherwise null if isPayloadAvailable is false
|
||||
* @throws java.io.IOException
|
||||
|
|
|
@ -22,7 +22,10 @@ import java.util.zip.CRC32;
|
|||
import java.util.zip.Checksum;
|
||||
|
||||
/** Writes bytes through to a primary IndexOutput, computing
|
||||
* checksum as it goes. Note that you cannot use seek(). */
|
||||
* checksum as it goes. Note that you cannot use seek().
|
||||
*
|
||||
* @lucene.internal
|
||||
*/
|
||||
public class ChecksumIndexInput extends IndexInput {
|
||||
IndexInput main;
|
||||
Checksum digest;
|
||||
|
|
|
@ -22,7 +22,10 @@ import java.util.zip.CRC32;
|
|||
import java.util.zip.Checksum;
|
||||
|
||||
/** Writes bytes through to a primary IndexOutput, computing
|
||||
* checksum. Note that you cannot use seek().*/
|
||||
* checksum. Note that you cannot use seek().
|
||||
*
|
||||
* @lucene.internal
|
||||
*/
|
||||
public class ChecksumIndexOutput extends IndexOutput {
|
||||
IndexOutput main;
|
||||
Checksum digest;
|
||||
|
|
|
@ -31,8 +31,7 @@ import java.util.Set;
|
|||
* to this class, and must allow multiple threads to call
|
||||
* contains at once.</p>
|
||||
*
|
||||
* <p><b>NOTE</b>: this API is new and experimental and is
|
||||
* subject to suddenly change in the next release.
|
||||
* @lucene.experimental
|
||||
*/
|
||||
|
||||
public class FileSwitchDirectory extends Directory {
|
||||
|
|
|
@ -19,6 +19,8 @@ package org.apache.lucene.util;
|
|||
|
||||
/**
|
||||
* Methods for manipulating arrays.
|
||||
*
|
||||
* @lucene.internal
|
||||
*/
|
||||
public final class ArrayUtil {
|
||||
/*
|
||||
|
|
|
@ -18,6 +18,7 @@
|
|||
package org.apache.lucene.util; // from org.apache.solr.util rev 555343
|
||||
|
||||
/** A variety of high efficiency bit twiddling routines.
|
||||
* @lucene.internal
|
||||
*/
|
||||
public class BitUtil {
|
||||
|
||||
|
|
|
@ -24,6 +24,8 @@ import java.io.Reader;
|
|||
* {@link CharacterUtils} provides a unified interface to Character-related
|
||||
* operations to implement backwards compatible character operations based on a
|
||||
* {@link Version} instance.
|
||||
*
|
||||
* @lucene.internal
|
||||
*/
|
||||
public abstract class CharacterUtils {
|
||||
private static final Java4CharacterUtils JAVA_4 = new Java4CharacterUtils();
|
||||
|
|
|
@ -48,6 +48,8 @@ import java.util.Map;
|
|||
* {@link #close} takes care of all
|
||||
* threads. You should not call {@link #close} until all
|
||||
* threads are done using the instance.
|
||||
*
|
||||
* @lucene.internal
|
||||
*/
|
||||
|
||||
public class CloseableThreadLocal<T> implements Closeable {
|
||||
|
|
|
@ -24,6 +24,7 @@ import java.util.concurrent.locks.ReentrantLock;
|
|||
|
||||
/**
|
||||
* A dummy lock as a replacement for {@link ReentrantLock} to disable locking
|
||||
* @lucene.internal
|
||||
*/
|
||||
public final class DummyConcurrentLock implements Lock {
|
||||
|
||||
|
|
|
@ -17,7 +17,9 @@ package org.apache.lucene.util;
|
|||
* limitations under the License.
|
||||
*/
|
||||
|
||||
|
||||
/**
|
||||
* @lucene.internal
|
||||
*/
|
||||
public class English {
|
||||
|
||||
public static String longToEnglish(long i) {
|
||||
|
|
|
@ -44,11 +44,7 @@ import org.apache.lucene.search.FieldCache.CacheEntry;
|
|||
* Unit tests) to check at run time if the FieldCache contains "insane"
|
||||
* usages of the FieldCache.
|
||||
* </p>
|
||||
* <p>
|
||||
* <b>EXPERIMENTAL API:</b> This API is considered extremely advanced and
|
||||
* experimental. It may be removed or altered w/o warning in future releases
|
||||
* of Lucene.
|
||||
* </p>
|
||||
* @lucene.experimental
|
||||
* @see FieldCache
|
||||
* @see FieldCacheSanityChecker.Insanity
|
||||
* @see FieldCacheSanityChecker.InsanityType
|
||||
|
|
|
@ -50,6 +50,8 @@ import java.nio.ByteBuffer;
|
|||
* WARNING: This means that the deprecated Buffer-based methods
|
||||
* only work correctly with buffers that have an offset of 0. For example, they
|
||||
* will not correctly interpret buffers returned by {@link ByteBuffer#slice}.
|
||||
*
|
||||
* @lucene.experimental
|
||||
*/
|
||||
public class IndexableBinaryStringTools {
|
||||
|
||||
|
|
|
@ -25,6 +25,7 @@ import java.util.Map;
|
|||
|
||||
/**
|
||||
* Helper class for keeping Lists of Objects associated with keys. <b>WARNING: THIS CLASS IS NOT THREAD SAFE</b>
|
||||
* @lucene.internal
|
||||
*/
|
||||
public class MapOfSets<K, V> {
|
||||
|
||||
|
|
|
@ -55,8 +55,7 @@ import org.apache.lucene.search.NumericRangeFilter; // for javadocs
|
|||
* {@link String#compareTo(String)}) representations of numeric data types for other
|
||||
* usages (e.g. sorting).
|
||||
*
|
||||
* <p><font color="red"><b>NOTE:</b> This API is experimental and
|
||||
* might change in incompatible ways in the next release.</font>
|
||||
* @lucene.experimental
|
||||
*
|
||||
* @since 2.9
|
||||
*/
|
||||
|
|
|
@ -26,6 +26,7 @@ import java.util.Map;
|
|||
/**
|
||||
* A serializable Enum class.
|
||||
* @deprecated Use Java 5 enum, will be removed in a later Lucene 3.x release.
|
||||
* @lucene.internal
|
||||
*/
|
||||
@Deprecated
|
||||
@SuppressWarnings("serial")
|
||||
|
|
|
@ -23,7 +23,8 @@ package org.apache.lucene.util;
|
|||
*
|
||||
* <p><b>NOTE</b>: This class pre-allocates a full array of
|
||||
* length <code>maxSize+1</code>, in {@link #initialize}.
|
||||
*
|
||||
*
|
||||
* @lucene.internal
|
||||
*/
|
||||
public abstract class PriorityQueue<T> {
|
||||
private int size;
|
||||
|
|
|
@ -33,6 +33,8 @@ import java.util.*;
|
|||
* If checkInterned, all Strings checked will be interned, but those
|
||||
* that were not already interned will be released for GC when the
|
||||
* estimate is complete.
|
||||
*
|
||||
* @lucene.internal
|
||||
*/
|
||||
public final class RamUsageEstimator {
|
||||
private MemoryModel memoryModel;
|
||||
|
|
|
@ -25,6 +25,7 @@ import org.apache.lucene.index.IndexReader;
|
|||
/**
|
||||
* Common util methods for dealing with {@link IndexReader}s.
|
||||
*
|
||||
* @lucene.internal
|
||||
*/
|
||||
public class ReaderUtil {
|
||||
|
||||
|
|
|
@ -27,6 +27,8 @@ import org.apache.lucene.search.Scorer;
|
|||
/** A ScorerDocQueue maintains a partial ordering of its Scorers such that the
|
||||
least Scorer can always be found in constant time. Put()'s and pop()'s
|
||||
require log(size) time. The ordering is by Scorer.doc().
|
||||
*
|
||||
* @lucene.internal
|
||||
*/
|
||||
public class ScorerDocQueue { // later: SpansQueue for spans with doc and term positions
|
||||
private final HeapedScorerDoc[] heap;
|
||||
|
|
|
@ -19,7 +19,10 @@ package org.apache.lucene.util;
|
|||
|
||||
/**
|
||||
* Simple lockless and memory barrier free String intern cache that is guaranteed
|
||||
* to return the same String instance as String.intern() does.
|
||||
* to return the same String instance as String.intern()
|
||||
* does.
|
||||
*
|
||||
* @lucene.internal
|
||||
*/
|
||||
public class SimpleStringInterner extends StringInterner {
|
||||
|
||||
|
|
|
@ -17,6 +17,8 @@ package org.apache.lucene.util;
|
|||
|
||||
|
||||
/** Floating point numbers smaller than 32 bits.
|
||||
*
|
||||
* @lucene.internal
|
||||
*/
|
||||
public class SmallFloat {
|
||||
|
||||
|
|
|
@ -20,6 +20,8 @@ package org.apache.lucene.util;
|
|||
|
||||
/**
|
||||
* Methods for manipulating strings.
|
||||
*
|
||||
* @lucene.internal
|
||||
*/
|
||||
public abstract class StringHelper {
|
||||
/**
|
||||
|
|
|
@ -54,8 +54,7 @@ package org.apache.lucene.util;
|
|||
* without always allocating a new byte[] as
|
||||
* String.getBytes("UTF-8") does.
|
||||
*
|
||||
* <p><b>WARNING</b>: This API is a new and experimental and
|
||||
* may suddenly change. </p>
|
||||
* @lucene.internal
|
||||
*/
|
||||
|
||||
final public class UnicodeUtil {
|
||||
|
@ -72,6 +71,9 @@ final public class UnicodeUtil {
|
|||
private static final long HALF_SHIFT = 10;
|
||||
private static final long HALF_MASK = 0x3FFL;
|
||||
|
||||
/**
|
||||
* @lucene.internal
|
||||
*/
|
||||
public static final class UTF8Result {
|
||||
public byte[] result = new byte[10];
|
||||
public int length;
|
||||
|
@ -84,6 +86,9 @@ final public class UnicodeUtil {
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @lucene.internal
|
||||
*/
|
||||
public static final class UTF16Result {
|
||||
public char[] result = new char[10];
|
||||
public int[] offsets = new int[10];
|
||||
|
|
|
@ -54,6 +54,8 @@ import java.util.Set;
|
|||
* The one with the larger distance should be used preferable.
|
||||
* This way also more complicated method rename scenarios can be handled
|
||||
* (think of 2.9 {@code TokenStream} deprecations).</p>
|
||||
*
|
||||
* @lucene.internal
|
||||
*/
|
||||
public final class VirtualMethod<C> {
|
||||
|
||||
|
|
|
@ -21,6 +21,8 @@ import java.io.Closeable;
|
|||
|
||||
/**
|
||||
* Base class for cache implementations.
|
||||
*
|
||||
* @lucene.internal
|
||||
*/
|
||||
public abstract class Cache<K,V> implements Closeable {
|
||||
|
||||
|
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue