lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Robert Muir (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (LUCENE-4425) Unclear documentation of StoredFieldVisitor.binaryValue
Date Tue, 25 Sep 2012 12:42:08 GMT

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

Robert Muir commented on LUCENE-4425:
-------------------------------------

If we change this API, one way is to do it trunk only, and we add docs for 4.1?

However StoredFieldsVisitor is an abstract class (not an interface), so maybe
its not the only option. 
                
> 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


Mime
View raw message