diff --git a/src/java/org/apache/lucene/analysis/TeeSinkTokenFilter.java b/src/java/org/apache/lucene/analysis/TeeSinkTokenFilter.java index 2609b323555..e34d60239f7 100644 --- a/src/java/org/apache/lucene/analysis/TeeSinkTokenFilter.java +++ b/src/java/org/apache/lucene/analysis/TeeSinkTokenFilter.java @@ -150,9 +150,13 @@ public final class TeeSinkTokenFilter extends TokenFilter { } /** - * TODO: Missing Docs + * A filter that decides which {@link AttributeSource} states to store in the sink. */ public static interface SinkFilter { + /** + * Returns true, iff the current state of the passed-in {@link AttributeSource} shall be stored + * in the sink. + */ boolean accept(AttributeSource source); } diff --git a/src/java/org/apache/lucene/analysis/Token.java b/src/java/org/apache/lucene/analysis/Token.java index d5a98834a7b..041407ebe5f 100644 --- a/src/java/org/apache/lucene/analysis/Token.java +++ b/src/java/org/apache/lucene/analysis/Token.java @@ -235,7 +235,7 @@ public class Token extends AttributeImpl * @param text term text * @param start start offset * @param end end offset - * @deprecated + * @deprecated Use {@link #Token(char[], int, int, int, int)} instead. */ public Token(String text, int start, int end) { termText = text; @@ -251,7 +251,7 @@ public class Token extends AttributeImpl * @param start start offset * @param end end offset * @param typ token type - * @deprecated + * @deprecated Use {@link #Token(char[], int, int, int, int)} and {@link #setType(String)} instead. */ public Token(String text, int start, int end, String typ) { termText = text; @@ -269,7 +269,7 @@ public class Token extends AttributeImpl * @param start * @param end * @param flags token type bits - * @deprecated + * @deprecated Use {@link #Token(char[], int, int, int, int)} and {@link #setFlags(int)} instead. */ public Token(String text, int start, int end, int flags) { termText = text; diff --git a/src/java/org/apache/lucene/analysis/TokenFilter.java b/src/java/org/apache/lucene/analysis/TokenFilter.java index 24b22f1adc0..98b753651ad 100644 --- a/src/java/org/apache/lucene/analysis/TokenFilter.java +++ b/src/java/org/apache/lucene/analysis/TokenFilter.java @@ -26,10 +26,6 @@ import java.io.IOException; {@link #incrementToken()} if the new TokenStream API is used and {@link #next(Token)} or {@link #next()} if the old TokenStream API is used. - *

- * WARNING: The status of the new TokenStream, AttributeSource and Attributes is experimental. - * The APIs introduced in these classes with Lucene 2.9 might change in the future. - * We will make our best efforts to keep the APIs backwards-compatible.

See {@link TokenStream} */ diff --git a/src/java/org/apache/lucene/analysis/TokenStream.java b/src/java/org/apache/lucene/analysis/TokenStream.java index e51e42477b7..e2bd0bee8ae 100644 --- a/src/java/org/apache/lucene/analysis/TokenStream.java +++ b/src/java/org/apache/lucene/analysis/TokenStream.java @@ -68,11 +68,7 @@ import org.apache.lucene.util.AttributeSource; {@link TeeSinkTokenFilter}). For this usecase {@link AttributeSource#captureState} and {@link AttributeSource#restoreState} can be used. *

- * WARNING: The status of the new TokenStream, AttributeSource and Attributes is experimental. - * The APIs introduced in these classes with Lucene 2.9 might change in the future. - * We will make our best efforts to keep the APIs backwards-compatible. - */ - + */ public abstract class TokenStream extends AttributeSource { /** @deprecated Remove this when old API is removed! */ diff --git a/src/java/org/apache/lucene/analysis/Tokenizer.java b/src/java/org/apache/lucene/analysis/Tokenizer.java index c77aca62707..5e4d9dbafed 100644 --- a/src/java/org/apache/lucene/analysis/Tokenizer.java +++ b/src/java/org/apache/lucene/analysis/Tokenizer.java @@ -30,10 +30,6 @@ import java.io.IOException;

NOTE: subclasses overriding {@link #next(Token)} must call {@link Token#clear()}. - *

- * WARNING: The status of the new TokenStream, AttributeSource and Attributes is experimental. - * The APIs introduced in these classes with Lucene 2.9 might change in the future. - * We will make our best efforts to keep the APIs backwards-compatible. */ public abstract class Tokenizer extends TokenStream { diff --git a/src/java/org/apache/lucene/analysis/package.html b/src/java/org/apache/lucene/analysis/package.html index 641a47f6f01..1ce29adb848 100644 --- a/src/java/org/apache/lucene/analysis/package.html +++ b/src/java/org/apache/lucene/analysis/package.html @@ -466,7 +466,7 @@ This should be the usual behavior. However, there is also an expert-API that all and returns an actual instance. You can implement your own factory if you need to change the default behavior.

Now here is the actual class that implements our new Attribute. Notice that the class has to extend -{@link org.apache.lucene.util.AttributeSource.AttributeImpl}: +{@link org.apache.lucene.util.AttributeImpl}:

 public final class PartOfSpeechAttributeImpl extends AttributeImpl 
diff --git a/src/java/org/apache/lucene/analysis/tokenattributes/FlagsAttribute.java b/src/java/org/apache/lucene/analysis/tokenattributes/FlagsAttribute.java
index cca1503a889..6c1f6ef70d4 100644
--- a/src/java/org/apache/lucene/analysis/tokenattributes/FlagsAttribute.java
+++ b/src/java/org/apache/lucene/analysis/tokenattributes/FlagsAttribute.java
@@ -22,12 +22,6 @@ import org.apache.lucene.util.Attribute;
 /**
  * This attribute can be used to pass different flags down the tokenizer chain,
  * e. g. from one TokenFilter to another one. 
- * 
- * 

- * WARNING: The status of the new TokenStream, AttributeSource and Attributes is experimental. - * The APIs introduced in these classes with Lucene 2.9 might change in the future. - * We will make our best efforts to keep the APIs backwards-compatible. - */ public interface FlagsAttribute extends Attribute { /** diff --git a/src/java/org/apache/lucene/analysis/tokenattributes/FlagsAttributeImpl.java b/src/java/org/apache/lucene/analysis/tokenattributes/FlagsAttributeImpl.java index a22b82a7c66..2c69a9ae39d 100644 --- a/src/java/org/apache/lucene/analysis/tokenattributes/FlagsAttributeImpl.java +++ b/src/java/org/apache/lucene/analysis/tokenattributes/FlagsAttributeImpl.java @@ -24,12 +24,6 @@ import org.apache.lucene.util.AttributeImpl; /** * This attribute can be used to pass different flags down the tokenizer chain, * e. g. from one TokenFilter to another one. - * - *

- * WARNING: The status of the new TokenStream, AttributeSource and Attributes is experimental. - * The APIs introduced in these classes with Lucene 2.9 might change in the future. - * We will make our best efforts to keep the APIs backwards-compatible. - */ public class FlagsAttributeImpl extends AttributeImpl implements FlagsAttribute, Cloneable, Serializable { private int flags = 0; diff --git a/src/java/org/apache/lucene/analysis/tokenattributes/OffsetAttribute.java b/src/java/org/apache/lucene/analysis/tokenattributes/OffsetAttribute.java index b85bab42b76..22d40f79e9b 100644 --- a/src/java/org/apache/lucene/analysis/tokenattributes/OffsetAttribute.java +++ b/src/java/org/apache/lucene/analysis/tokenattributes/OffsetAttribute.java @@ -21,11 +21,6 @@ import org.apache.lucene.util.Attribute; /** * The start and end character offset of a Token. - * - *

- * WARNING: The status of the new TokenStream, AttributeSource and Attributes is experimental. - * The APIs introduced in these classes with Lucene 2.9 might change in the future. - * We will make our best efforts to keep the APIs backwards-compatible. */ public interface OffsetAttribute extends Attribute { /** Returns this Token's starting offset, the position of the first character diff --git a/src/java/org/apache/lucene/analysis/tokenattributes/OffsetAttributeImpl.java b/src/java/org/apache/lucene/analysis/tokenattributes/OffsetAttributeImpl.java index cb4eb5e4c2b..a28bfbe6b4e 100644 --- a/src/java/org/apache/lucene/analysis/tokenattributes/OffsetAttributeImpl.java +++ b/src/java/org/apache/lucene/analysis/tokenattributes/OffsetAttributeImpl.java @@ -23,11 +23,6 @@ import org.apache.lucene.util.AttributeImpl; /** * The start and end character offset of a Token. - * - *

- * WARNING: The status of the new TokenStream, AttributeSource and Attributes is experimental. - * The APIs introduced in these classes with Lucene 2.9 might change in the future. - * We will make our best efforts to keep the APIs backwards-compatible. */ public class OffsetAttributeImpl extends AttributeImpl implements OffsetAttribute, Cloneable, Serializable { private int startOffset; diff --git a/src/java/org/apache/lucene/analysis/tokenattributes/PayloadAttribute.java b/src/java/org/apache/lucene/analysis/tokenattributes/PayloadAttribute.java index 2bffe62a233..006cc5ed81a 100644 --- a/src/java/org/apache/lucene/analysis/tokenattributes/PayloadAttribute.java +++ b/src/java/org/apache/lucene/analysis/tokenattributes/PayloadAttribute.java @@ -22,11 +22,6 @@ import org.apache.lucene.util.Attribute; /** * The payload of a Token. See also {@link Payload}. - * - *

- * WARNING: The status of the new TokenStream, AttributeSource and Attributes is experimental. - * The APIs introduced in these classes with Lucene 2.9 might change in the future. - * We will make our best efforts to keep the APIs backwards-compatible. */ public interface PayloadAttribute extends Attribute { /** diff --git a/src/java/org/apache/lucene/analysis/tokenattributes/PayloadAttributeImpl.java b/src/java/org/apache/lucene/analysis/tokenattributes/PayloadAttributeImpl.java index 67923010812..4471e69ca0a 100644 --- a/src/java/org/apache/lucene/analysis/tokenattributes/PayloadAttributeImpl.java +++ b/src/java/org/apache/lucene/analysis/tokenattributes/PayloadAttributeImpl.java @@ -24,11 +24,6 @@ import org.apache.lucene.util.AttributeImpl; /** * The payload of a Token. See also {@link Payload}. - * - *

- * WARNING: The status of the new TokenStream, AttributeSource and Attributes is experimental. - * The APIs introduced in these classes with Lucene 2.9 might change in the future. - * We will make our best efforts to keep the APIs backwards-compatible. */ public class PayloadAttributeImpl extends AttributeImpl implements PayloadAttribute, Cloneable, Serializable { private Payload payload; diff --git a/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttribute.java b/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttribute.java index 947758c6469..bbb8cf24b7b 100644 --- a/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttribute.java +++ b/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttribute.java @@ -43,11 +43,6 @@ import org.apache.lucene.util.Attribute; * * * - *

- * WARNING: The status of the new TokenStream, AttributeSource and Attributes is experimental. - * The APIs introduced in these classes with Lucene 2.9 might change in the future. - * We will make our best efforts to keep the APIs backwards-compatible. - * * @see org.apache.lucene.index.TermPositions */ public interface PositionIncrementAttribute extends Attribute { diff --git a/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttributeImpl.java b/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttributeImpl.java index 84fcf58680b..99e42e38d34 100644 --- a/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttributeImpl.java +++ b/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttributeImpl.java @@ -45,13 +45,6 @@ import org.apache.lucene.util.AttributeImpl; * occur with no intervening stop words. * * - * - *

- * WARNING: The status of the new TokenStream, AttributeSource and Attributes is experimental. - * The APIs introduced in these classes with Lucene 2.9 might change in the future. - * We will make our best efforts to keep the APIs backwards-compatible. - * - * @see org.apache.lucene.index.TermPositions */ public class PositionIncrementAttributeImpl extends AttributeImpl implements PositionIncrementAttribute, Cloneable, Serializable { private int positionIncrement = 1; diff --git a/src/java/org/apache/lucene/analysis/tokenattributes/TermAttribute.java b/src/java/org/apache/lucene/analysis/tokenattributes/TermAttribute.java index 72db22819d4..49201cf0765 100644 --- a/src/java/org/apache/lucene/analysis/tokenattributes/TermAttribute.java +++ b/src/java/org/apache/lucene/analysis/tokenattributes/TermAttribute.java @@ -21,11 +21,6 @@ import org.apache.lucene.util.Attribute; /** * The term text of a Token. - * - *

- * WARNING: The status of the new TokenStream, AttributeSource and Attributes is experimental. - * The APIs introduced in these classes with Lucene 2.9 might change in the future. - * We will make our best efforts to keep the APIs backwards-compatible. */ public interface TermAttribute extends Attribute { /** Returns the Token's term text. diff --git a/src/java/org/apache/lucene/analysis/tokenattributes/TermAttributeImpl.java b/src/java/org/apache/lucene/analysis/tokenattributes/TermAttributeImpl.java index b160f321a94..462b1ecf62a 100644 --- a/src/java/org/apache/lucene/analysis/tokenattributes/TermAttributeImpl.java +++ b/src/java/org/apache/lucene/analysis/tokenattributes/TermAttributeImpl.java @@ -24,11 +24,6 @@ import org.apache.lucene.util.AttributeImpl; /** * The term text of a Token. - * - *

- * WARNING: The status of the new TokenStream, AttributeSource and Attributes is experimental. - * The APIs introduced in these classes with Lucene 2.9 might change in the future. - * We will make our best efforts to keep the APIs backwards-compatible. */ public class TermAttributeImpl extends AttributeImpl implements TermAttribute, Cloneable, Serializable { private static int MIN_BUFFER_SIZE = 10; diff --git a/src/java/org/apache/lucene/analysis/tokenattributes/TypeAttribute.java b/src/java/org/apache/lucene/analysis/tokenattributes/TypeAttribute.java index 7781774d216..4ab562e36dd 100644 --- a/src/java/org/apache/lucene/analysis/tokenattributes/TypeAttribute.java +++ b/src/java/org/apache/lucene/analysis/tokenattributes/TypeAttribute.java @@ -21,11 +21,6 @@ import org.apache.lucene.util.Attribute; /** * A Token's lexical type. The Default value is "word". - * - *

- * WARNING: The status of the new TokenStream, AttributeSource and Attributes is experimental. - * The APIs introduced in these classes with Lucene 2.9 might change in the future. - * We will make our best efforts to keep the APIs backwards-compatible. */ public interface TypeAttribute extends Attribute { /** Returns this Token's lexical type. Defaults to "word". */ diff --git a/src/java/org/apache/lucene/analysis/tokenattributes/TypeAttributeImpl.java b/src/java/org/apache/lucene/analysis/tokenattributes/TypeAttributeImpl.java index b0b06bd00dd..95d754994b4 100644 --- a/src/java/org/apache/lucene/analysis/tokenattributes/TypeAttributeImpl.java +++ b/src/java/org/apache/lucene/analysis/tokenattributes/TypeAttributeImpl.java @@ -23,11 +23,6 @@ import org.apache.lucene.util.AttributeImpl; /** * A Token's lexical type. The Default value is "word". - * - *

- * WARNING: The status of the new TokenStream, AttributeSource and Attributes is experimental. - * The APIs introduced in these classes with Lucene 2.9 might change in the future. - * We will make our best efforts to keep the APIs backwards-compatible. */ public class TypeAttributeImpl extends AttributeImpl implements TypeAttribute, Cloneable, Serializable { private String type; diff --git a/src/java/org/apache/lucene/util/Attribute.java b/src/java/org/apache/lucene/util/Attribute.java index 0a39ef0e26b..38a0ecebe3e 100644 --- a/src/java/org/apache/lucene/util/Attribute.java +++ b/src/java/org/apache/lucene/util/Attribute.java @@ -19,11 +19,6 @@ package org.apache.lucene.util; /** * Base interface for attributes. - * - *

- * WARNING: The status of the new TokenStream, AttributeSource and Attributes is experimental. - * The APIs introduced in these classes with Lucene 2.9 might change in the future. - * We will make our best efforts to keep the APIs backwards-compatible. */ public interface Attribute { public void clear(); diff --git a/src/java/org/apache/lucene/util/AttributeImpl.java b/src/java/org/apache/lucene/util/AttributeImpl.java index 976cbec7a04..39ca328ed9f 100644 --- a/src/java/org/apache/lucene/util/AttributeImpl.java +++ b/src/java/org/apache/lucene/util/AttributeImpl.java @@ -26,10 +26,6 @@ import java.lang.reflect.Field; *

* Attributes are used to add data in a dynamic, yet type-safe way to a source * of usually streamed objects, e. g. a {@link org.apache.lucene.analysis.TokenStream}. - *

- * WARNING: The status of the new TokenStream, AttributeSource and Attributes is experimental. - * The APIs introduced in these classes with Lucene 2.9 might change in the future. - * We will make our best efforts to keep the APIs backwards-compatible. */ public abstract class AttributeImpl implements Cloneable, Serializable { /** diff --git a/src/java/org/apache/lucene/util/AttributeSource.java b/src/java/org/apache/lucene/util/AttributeSource.java index f596c8ee0fc..fb14542375f 100644 --- a/src/java/org/apache/lucene/util/AttributeSource.java +++ b/src/java/org/apache/lucene/util/AttributeSource.java @@ -35,11 +35,6 @@ import org.apache.lucene.analysis.TokenStream; // for javadocs * the {@link #addAttribute(Class)}, which then checks if an instance of * that type is already present. If yes, it returns the instance, otherwise * it creates a new instance and returns it. - * - *

- * WARNING: The status of the new TokenStream, AttributeSource and Attributes is experimental. - * The APIs introduced in these classes with Lucene 2.9 might change in the future. - * We will make our best efforts to keep the APIs backwards-compatible. */ public class AttributeSource { /**