You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-commits@lucene.apache.org by us...@apache.org on 2009/09/25 17:58:58 UTC

svn commit: r818894 - /lucene/java/trunk/src/java/org/apache/lucene/analysis/TokenStream.java

Author: uschindler
Date: Fri Sep 25 15:58:58 2009
New Revision: 818894

URL: http://svn.apache.org/viewvc?rev=818894&view=rev
Log:
LUCENE-1926: Javadoc updates for TokenStream to prevent other people from doing the same error like Robert :-)

Modified:
    lucene/java/trunk/src/java/org/apache/lucene/analysis/TokenStream.java

Modified: lucene/java/trunk/src/java/org/apache/lucene/analysis/TokenStream.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/analysis/TokenStream.java?rev=818894&r1=818893&r2=818894&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/analysis/TokenStream.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/analysis/TokenStream.java Fri Sep 25 15:58:58 2009
@@ -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.
+   * <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



RE: svn commit: r818894 - /lucene/java/trunk/src/java/org/apache/lucene/analysis/TokenStream.java

Posted by Uwe Schindler <uw...@thetaphi.de>.
Should I commit this also to the 2.9 branch or will we do this in a big
merge before releasing?

-----
Uwe Schindler
H.-H.-Meier-Allee 63, D-28213 Bremen
http://www.thetaphi.de
eMail: uwe@thetaphi.de

> -----Original Message-----
> From: uschindler@apache.org [mailto:uschindler@apache.org]
> Sent: Friday, September 25, 2009 5:59 PM
> To: java-commits@lucene.apache.org
> Subject: svn commit: r818894 -
> /lucene/java/trunk/src/java/org/apache/lucene/analysis/TokenStream.java
> 
> Author: uschindler
> Date: Fri Sep 25 15:58:58 2009
> New Revision: 818894
> 
> URL: http://svn.apache.org/viewvc?rev=818894&view=rev
> Log:
> LUCENE-1926: Javadoc updates for TokenStream to prevent other people from
> doing the same error like Robert :-)
> 
> Modified:
>     lucene/java/trunk/src/java/org/apache/lucene/analysis/TokenStream.java
> 
> Modified:
> lucene/java/trunk/src/java/org/apache/lucene/analysis/TokenStream.java
> URL:
> http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/
> analysis/TokenStream.java?rev=818894&r1=818893&r2=818894&view=diff
> ==========================================================================
> ====
> --- lucene/java/trunk/src/java/org/apache/lucene/analysis/TokenStream.java
> (original)
> +++ lucene/java/trunk/src/java/org/apache/lucene/analysis/TokenStream.java
> Fri Sep 25 15:58:58 2009
> @@ -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.
> +   * <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
> 



---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org