Index: src/java/org/apache/lucene/analysis/TokenStream.java =================================================================== --- src/java/org/apache/lucene/analysis/TokenStream.java (revision 818640) +++ src/java/org/apache/lucene/analysis/TokenStream.java (working copy) @@ -287,6 +287,11 @@ * the next token. Implementing classes must implement this method and update * the appropriate {@link AttributeImpl}s with the attributes of the next * token. + *
+ * 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. *
* This method is called for every token of a document, so an efficient * implementation is crucial for good performance. To avoid calls to