[LUCENE-4786] Out of date API document-SinkTokenizer

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 4.1
• Component/s: modules/analysis
• Lucene Fields: New
• Assignee: Unassigned
• Reporter: Hao Zhong
• Created: 20/Feb/13 17:56
• Updated: 28/Aug/22 13:39
• Resolved: 22/Feb/13 00:12

Description

The following API document talks about SinkTokenizer:
http://lucene.apache.org/core/4_1_0/analyzers-common/org/apache/lucene/analysis/sinks/package-summary.html

However, SinkTokenizer is deleted and replaced by TeeSinkTokenFilter in lucene 4.1, according to the change log:
http://lucene.apache.org/core/4_1_0/changes/Changes.html

LUCENE-1422, LUCENE-1693: New TokenStream API that uses a new class called AttributeSource instead of the Token class, which is now a utility class that holds common Token attributes. All attributes that the Token class had have been moved into separate classes: TermAttribute, OffsetAttribute, PositionIncrementAttribute, PayloadAttribute, TypeAttribute and FlagsAttribute. The new API is much more flexible; it allows to combine the Attributes arbitrarily and also to define custom Attributes. The new API has the same performance as the old next(Token) approach. For conformance with this new API Tee-/SinkTokenizer was deprecated and replaced by a new TeeSinkTokenFilter.

Please update the API documents to reflect the latest code.