Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LUCENE-1926: Javadoc updates for TokenStream to prevent other people from doing the same error like Robert :-) 

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@818894 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Uwe Schindler 2009-09-25 15:58:58 +00:00
parent da19413d09
commit 6ab7c91c83
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/java/org/apache/lucene/analysis/TokenStream.java
View File

@ -287,6 +287,11 @@ public abstract class TokenStream extends AttributeSource {
* the next token. Implementing classes must implement this method and update
* the appropriate {@link AttributeImpl}s with the attributes of the next
* token.
* <P>
* The producer must make no assumptions about the attributes after the method
* has been returned: the caller may arbitrarily change it. If the producer
* needs to preserve the state for subsequent calls, it can use
* {@link #captureState} to create a copy of the current attribute state.
* <p>
* This method is called for every token of a document, so an efficient
* implementation is crucial for good performance. To avoid calls to