svn commit: r478361 - /lucene/java/trunk/contrib/memory/src/java/org/apache/lucene/index/memory/AnalyzerUtil.java

[wh...@apache.org]

Author: whoschek
Date: Wed Nov 22 14:57:59 2006
New Revision: 478361

URL: http://svn.apache.org/viewvc?view=rev&rev=478361
Log:
javadoc

Modified:
    lucene/java/trunk/contrib/memory/src/java/org/apache/lucene/index/memory/AnalyzerUtil.java

Modified: lucene/java/trunk/contrib/memory/src/java/org/apache/lucene/index/memory/AnalyzerUtil.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/contrib/memory/src/java/org/apache/lucene/index/memory/AnalyzerUtil.java?view=diff&rev=478361&r1=478360&r2=478361
==============================================================================
--- lucene/java/trunk/contrib/memory/src/java/org/apache/lucene/index/memory/AnalyzerUtil.java (original)
+++ lucene/java/trunk/contrib/memory/src/java/org/apache/lucene/index/memory/AnalyzerUtil.java Wed Nov 22 14:57:59 2006
@@ -209,9 +209,11 @@
    * <p>
    * This can help improve performance in the presence of expensive Analyzer / TokenFilter chains.
    * <p>
-   * Caveats: Caching only works if the methods equals() and hashCode() methods are properly 
+   * Caveats: 
+   * 1) Caching only works if the methods equals() and hashCode() methods are properly 
    * implemented on the Reader passed to <code>tokenStream(String fieldName, Reader reader)</code>.
-   * Further, using caching on large Lucene documents can lead to out of memory exceptions.
+   * 2) Caching the tokens of large Lucene documents can lead to out of memory exceptions. 
+   * 3) The Token instances delivered by the underlying child analyzer must be immutable.
    * 
    * @param child
    *            the underlying child analyzer