Mailing-List: contact dev-help@lucene.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@lucene.apache.org
Date: Wed, 26 Sep 2012 02:21:08 +1100 (NCT)
From: "Michael McCandless (JIRA)" <jira@apache.org>
To: dev@lucene.apache.org
Message-ID: <19762367.122656.1348586468130.JavaMail.jiratomcat@arcas>
In-Reply-To: <1345629202.121699.1348575848209.JavaMail.jiratomcat@arcas>
Subject: [jira] [Commented] (LUCENE-4425) Unclear documentation of
 StoredFieldVisitor.binaryValue
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit


    [ https://issues.apache.org/jira/browse/LUCENE-4425?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13462859#comment-13462859 ] 

Michael McCandless commented on LUCENE-4425:
--------------------------------------------

+1 to remove offset/length and make it clear that you can hold onto that byte[] (caller will not reuse it).
                
> Unclear documentation of StoredFieldVisitor.binaryValue
> -------------------------------------------------------
>
>                 Key: LUCENE-4425
>                 URL: https://issues.apache.org/jira/browse/LUCENE-4425
>             Project: Lucene - Core
>          Issue Type: Bug
>    Affects Versions: 4.0
>            Reporter: Adrien Grand
>            Priority: Minor
>             Fix For: 4.1, 5.0
>
>
> When reading the binary value of a stored field, a StoredFieldsReader calls StoredFieldVisitor.binaryValue(arr, offset, length).
> Documentation currently doesn't state whether the byte[] can be reused outside of the scope of {{StoredFieldVisitor.binaryValue}} but {{DocumentStoredFieldVisitor}} assumes (as of r1389812) that it can.
> So {{DocumentStoredFieldVisitor}} would break with a custom {{StoredFieldsFormat}} that would call {{StoredFieldVisitor.binaryValue}} with a slice of a reusable buffer.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

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