[LUCENE-1875] Javadoc of TokenStream.end() somehow confusing

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.9
• Fix Version/s: 2.9
• Component/s: modules/analysis
• Lucene Fields: New
• Assignee: Uwe Schindler
• Reporter: Uwe Schindler
• Created: 30/Aug/09 09:45
• Updated: 28/Aug/22 12:08
• Resolved: 30/Aug/09 17:11

Description

The Javadocs of TokenStream.end() are somehow confusing, because they also refer to the old TokenStream API ("after next() returned null"). But one who implements his TokenStream with the old API cannot make use of the end() feature, as he would not use attributes and so cannot update the end offsets (he could, but then he should rewrite the whole TokenStream). To be conform to the old API, there must be an end(Token) method, which we will not add.

I would drop the old API from this docs.