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

Jianbin Wei commented on HADOOP-8608:
-------------------------------------

I am looking for some document like in TimeUnit.convert that includes examples 
and warning. Not warning in the code.

{code}
/**
  * Return time duration in the given time unit. Valid units are encoded in
  * properties as suffixes: nanoseconds (ns), microseconds (us), milliseconds
  * (ms), seconds (s), minutes (m), hours (h), and days (d).  
  * For example, the value can be 10ns, 10us, 10ms, 10s, and etc. 
  * Note getting time duration set in finer granularity as coarser granularity 
can lose precision.  
  * For example, if property "example.duration" is set to 999ms, 
  * <tt>getTimeDuration("example.duration", 1L, TimeUnit.SECONDS)</tt> returns 
0.
{code}

Some other minor points:
* In {{ParsedTimeDuration.unitFor}} the {{return null;}} is never executed.
* In the same method, you used "pdt". I guess you mean "ptd".
                
> Add Configuration API for parsing time durations
> ------------------------------------------------
>
>                 Key: HADOOP-8608
>                 URL: https://issues.apache.org/jira/browse/HADOOP-8608
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: conf
>    Affects Versions: 3.0.0
>            Reporter: Todd Lipcon
>         Attachments: 8608-0.patch, 8608-1.patch
>
>
> Hadoop has a lot of configurations which specify durations or intervals of 
> time. Unfortunately these different configurations have little consistency in 
> units - eg some are in milliseconds, some in seconds, and some in minutes. 
> This makes it difficult for users to configure, since they have to always 
> refer back to docs to remember the unit for each property.
> The proposed solution is to add an API like {{Configuration.getTimeDuration}} 
> which allows the user to specify the units with a postfix. For example, 
> "10ms", "10s", "10m", "10h", or even "10d". For backwards-compatibility, if 
> the user does not specify a unit, the API can specify the default unit, and 
> warn the user that they should specify an explicit unit instead.

--
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

Reply via email to