Mailing-List: contact java-dev-help@lucene.apache.org; run by ezmlm
Precedence: bulk
Reply-To: java-dev@lucene.apache.org
Message-ID: <187580.1149912570199.JavaMail.jira@brutus>
Date: Sat, 10 Jun 2006 04:09:30 +0000 (GMT+00:00)
From: "Otis Gospodnetic (JIRA)" <jira@apache.org>
To: java-dev@lucene.apache.org
Subject: [jira] Resolved: (LUCENE-594) Javadoc - Field constructor with
 Reader needs comment about retained reference
In-Reply-To: <19025459.1149841710605.JavaMail.jira@brutus>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit

     [ http://issues.apache.org/jira/browse/LUCENE-594?page=all ]
     
Otis Gospodnetic resolved LUCENE-594:
-------------------------------------

    Resolution: Fixed

I already did this yesterday, I believe.  Thanks!


> Javadoc - Field constructor with Reader needs comment about retained reference
> ------------------------------------------------------------------------------
>
>          Key: LUCENE-594
>          URL: http://issues.apache.org/jira/browse/LUCENE-594
>      Project: Lucene - Java
>         Type: Improvement

>   Components: Index
>     Versions: 2.0.0
>     Reporter: Rob Staveley (Tom)
>     Priority: Minor

>
> If you don't dig into the Lucene internals, it isn't obvious the Field constructor http://lucene.apache.org/java/docs/api/org/apache/lucene/document/Field.html#Field%28java.lang.String,%20java.io.Reader%29 retains a reference to the reader for use later on. It would be useful to have a comment added to the Javadoc saying something like:
> Note: A reference to java.io.Reader is retained by the field. Reader is read from when the Document which this field is added to is itself added to the index.
> Without this, the caller is liable to do silly things like closing the stream after constructing the org.apache.lucene.document.Field.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


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