Module org.elasticsearch.base
Package org.elasticsearch.core

Class TimeValue

java.lang.Object
org.elasticsearch.core.TimeValue
All Implemented Interfaces:
Comparable<TimeValue>
public class TimeValue extends Object implements Comparable<TimeValue>

  • Field Details

    • NSEC_PER_MSEC

      public static final long NSEC_PER_MSEC
      How many nano-seconds in one milli-second

    • MINUS_ONE

      public static final TimeValue MINUS_ONE

    • ZERO

      public static final TimeValue ZERO

    • MAX_VALUE

      public static final TimeValue MAX_VALUE

    • THIRTY_SECONDS

      public static final TimeValue THIRTY_SECONDS

    • ONE_MINUTE

      public static final TimeValue ONE_MINUTE

  • Constructor Details

    • TimeValue

      public TimeValue(long millis)

    • TimeValue

      public TimeValue(long duration, TimeUnit timeUnit)

  • Method Details

    • timeValueNanos

      public static TimeValue timeValueNanos(long nanos)

    • timeValueMillis

      public static TimeValue timeValueMillis(long millis)

    • timeValueSeconds

      public static TimeValue timeValueSeconds(long seconds)

    • timeValueMinutes

      public static TimeValue timeValueMinutes(long minutes)

    • timeValueHours

      public static TimeValue timeValueHours(long hours)

    • timeValueDays

      public static TimeValue timeValueDays(long days)

    • min

      public static TimeValue min(TimeValue time1, TimeValue time2)
      Returns:
      the TimeValue object that has the least duration.

    • timeUnit

      public TimeUnit timeUnit()
      Returns:
      the unit used for the this time value, see duration()

    • duration

      public long duration()
      Returns:
      the number of timeUnit() units this value contains

    • nanos

      public long nanos()

    • getNanos

      public long getNanos()

    • micros

      public long micros()

    • getMicros

      public long getMicros()

    • millis

      public long millis()

    • getMillis

      public long getMillis()

    • seconds

      public long seconds()

    • getSeconds

      public long getSeconds()

    • minutes

      public long minutes()

    • getMinutes

      public long getMinutes()

    • hours

      public long hours()

    • getHours

      public long getHours()

    • days

      public long days()

    • getDays

      public long getDays()

    • microsFrac

      public double microsFrac()

    • getMicrosFrac

      public double getMicrosFrac()

    • millisFrac

      public double millisFrac()

    • getMillisFrac

      public double getMillisFrac()

    • secondsFrac

      public double secondsFrac()

    • getSecondsFrac

      public double getSecondsFrac()

    • minutesFrac

      public double minutesFrac()

    • getMinutesFrac

      public double getMinutesFrac()

    • hoursFrac

      public double hoursFrac()

    • getHoursFrac

      public double getHoursFrac()

    • daysFrac

      public double daysFrac()

    • getDaysFrac

      public double getDaysFrac()

    • toString

      public String toString()
      Returns a String representation of the current TimeValue. Note that this method might produce fractional time values (ex 1.6m) which cannot be parsed by method like parse(String, String, String, String). Also note that the maximum string value that will be generated is 106751.9d due to the way that values are internally converted to nanoseconds (106751.9 days is Long.MAX_VALUE nanoseconds)
      Overrides:
      toString in class Object

    • toHumanReadableString

      public String toHumanReadableString(int fractionPieces)
      Returns a String representation of the current TimeValue. Note that this method might produce fractional time values (ex 1.6m) which cannot be parsed by method like parse(String, String, String, String). The number of fractional decimals (up to 10 maximum) are truncated to the number of fraction pieces specified. Also note that the maximum string value that will be generated is 106751.9d due to the way that values are internally converted to nanoseconds (106751.9 days is Long.MAX_VALUE nanoseconds)
      Parameters:
      fractionPieces - the number of decimal places to include

    • getStringRep

      public String getStringRep()

    • parseTimeValue

      public static TimeValue parseTimeValue(String sValue, String settingName)
      Parameters:
      sValue - Value to parse, which may not be null.
      settingName - Name of the parameter or setting. On invalid input, this value is included in the exception message. Otherwise, this parameter is unused.
      Returns:
      The TimeValue which the input string represents.

    • parseTimeValue

      public static TimeValue parseTimeValue(@Nullable String sValue, TimeValue defaultValue, String settingName)
      Parameters:
      sValue - Value to parse, which may be null.
      defaultValue - Value to return if sValue is null.
      settingName - Name of the parameter or setting. On invalid input, this value is included in the exception message. Otherwise, this parameter is unused.
      Returns:
      The TimeValue which the input string represents, or defaultValue if the input is null.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • nsecToMSec

      public static long nsecToMSec(long ns)

    • compareTo

      public int compareTo(TimeValue timeValue)
      Specified by:
      compareTo in interface Comparable<TimeValue>