[jira] [Commented] (LUCENE-8805) Parameter changes for binaryField() and stringField() in StoredFieldVisitor

["Robert Muir (JIRA)" <ji...@apache.org>]

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

Robert Muir commented on LUCENE-8805:
-------------------------------------

Should we add any safety checks? With the previous code, because we created {{new BytesRef}} or {{new String}} there was some implicit null checks. So I am just thinking, rather than assign the String/BytesRef directly with code such as {{stringValue = value}} it might need {{stringValue = Objects.requireNonNull(value)}}. Otherwise a simple user mistake might give confusing exceptions or behavior, because it fails somewhere in low-level codecs code.

With BytesRef as an incoming parameter its more complicated, user can also screw up its instance variables directly and pass bogus stuff. Adding lots of checks beyond a simple null check might be controversial. A good compromise can be to at least add an assert to help users with their tests, e.g. {{assert value.isValid()}}

> Parameter changes for binaryField() and stringField() in StoredFieldVisitor
> ---------------------------------------------------------------------------
>
>                 Key: LUCENE-8805
>                 URL: https://issues.apache.org/jira/browse/LUCENE-8805
>             Project: Lucene - Core
>          Issue Type: Improvement
>            Reporter: Namgyu Kim
>            Priority: Major
>         Attachments: LUCENE-8805.patch
>
>
> I wrote this patch after seeing the comments left by [~mikemccand] when SortingStoredFieldsConsumer class was first created.
> {code:java}
> @Override
> public void binaryField(FieldInfo fieldInfo, byte[] value) throws IOException {
>   ...
>   // TODO: can we avoid new BR here?
>   ...
> }
> @Override
> public void stringField(FieldInfo fieldInfo, byte[] value) throws IOException {
>   ...
>   // TODO: can we avoid new String here?
>   ...
> }
> {code}
> I changed two things.
> 1) change binaryField() parameters from byte[] to BytesRef.
> 2) change stringField() parameters from byte[] to String.
> I also changed the related contents while doing the work.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

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