[jira] [Commented] (SOLR-16595) Standardize Builder handling of times

["Eric Pugh (Jira)" <ji...@apache.org>]

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

Eric Pugh commented on SOLR-16595:
----------------------------------

Copied from one of the discussions:

Can you use TimeUnit in the method to set it so it's clear what the unit is?
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/TimeUnit.html

So, the idea would be to go from setExpiry(int seconds) to setExpiry(int duration, TimeUnit unit) and then internally we change it to milliseconds or seconds depending on what we want to do.

> Standardize Builder handling of times
> -------------------------------------
>
>                 Key: SOLR-16595
>                 URL: https://issues.apache.org/jira/browse/SOLR-16595
>             Project: Solr
>          Issue Type: Sub-task
>          Components: clients - java
>    Affects Versions: 9.0
>            Reporter: Eric Pugh
>            Priority: Major
>
> COming out of another ticket:
> TimeUnit class was introduced in part to add clarity to call-sites of a method so the unit is clear. blah.setTime(TimeUnit.SECOND, 1) is fine as well as blah.setTime(TimeUnit.MINUTE,2) -- the caller picks the unit convenient to them. With that design, the method is designed unit-free -- definitely NOT with variables named "second" as you proposed since the unit could be anything. Internally (implementation of the setter), we need to pick a unit to standardize to on some internal field to store the result, and name the field to be clear as to what the internal unit chosen is. (e.g. retryExpirySecs). Again, that's internal, the caller choses a unit convenient to them.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org