java.lang.Object
- org.elasticsearch.common.unit.TimeValue

All Implemented Interfaces:: Comparable<TimeValue>

public class TimeValue
extends Object
implements Comparable<TimeValue>

Field Summary

Fields
Modifier and Type Field Description

static TimeValue MINUS_ONE

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

static TimeValue ZERO

Constructor Summary

Constructors
Constructor Description

TimeValue(long millis)

TimeValue(long duration, TimeUnit timeUnit)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(TimeValue timeValue)`
`long`	`days()`
`double`	`daysFrac()`
`long`	`duration()`
`boolean`	`equals(Object o)`
`long`	`getDays()`
`double`	`getDaysFrac()`
`long`	`getHours()`
`double`	`getHoursFrac()`
`long`	`getMicros()`
`double`	`getMicrosFrac()`
`long`	`getMillis()`
`double`	`getMillisFrac()`
`long`	`getMinutes()`
`double`	`getMinutesFrac()`
`long`	`getNanos()`
`long`	`getSeconds()`
`double`	`getSecondsFrac()`
`String`	`getStringRep()`
`int`	`hashCode()`
`long`	`hours()`
`double`	`hoursFrac()`
`long`	`micros()`
`double`	`microsFrac()`
`long`	`millis()`
`double`	`millisFrac()`
`long`	`minutes()`
`double`	`minutesFrac()`
`long`	`nanos()`
`static long`	`nsecToMSec(long ns)`
`static TimeValue`	`parseTimeValue(String sValue, String settingName)`
`static TimeValue`	`parseTimeValue(String sValue, TimeValue defaultValue, String settingName)`
`long`	`seconds()`
`double`	`secondsFrac()`
`TimeUnit`	`timeUnit()`
`static TimeValue`	`timeValueDays(long days)`
`static TimeValue`	`timeValueHours(long hours)`
`static TimeValue`	`timeValueMillis(long millis)`
`static TimeValue`	`timeValueMinutes(long minutes)`
`static TimeValue`	`timeValueNanos(long nanos)`
`static TimeValue`	`timeValueSeconds(long seconds)`
`String`	`toHumanReadableString(int fractionPieces)`	Returns a `String` representation of the current `TimeValue`.
`String`	`toString()`	Returns a `String` representation of the current `TimeValue`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

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

Constructor Detail

TimeValue
```
public TimeValue(long millis)
```

TimeValue

public TimeValue(long duration,
                 TimeUnit timeUnit)

Method Detail

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)

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

parseTimeValue

public static TimeValue parseTimeValue(String sValue,
                                       TimeValue defaultValue,
                                       String settingName)

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>

Modifier and Type	Field	Description
`static TimeValue`	`MINUS_ONE`
`static long`	`NSEC_PER_MSEC`	How many nano-seconds in one milli-second
`static TimeValue`	`ZERO`

Constructor	Description
`TimeValue(long millis)`
`TimeValue(long duration, TimeUnit timeUnit)`

Class TimeValue

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NSEC_PER_MSEC

MINUS_ONE

ZERO

Constructor Detail

TimeValue

TimeValue

Method Detail

timeValueNanos

timeValueMillis

timeValueSeconds

timeValueMinutes

timeValueHours

timeValueDays

timeUnit

duration

nanos

getNanos

micros

getMicros

millis

getMillis

seconds

getSeconds

minutes

getMinutes

hours

getHours

days

getDays

microsFrac

getMicrosFrac

millisFrac

getMillisFrac

secondsFrac

getSecondsFrac

minutesFrac

getMinutesFrac

hoursFrac

getHoursFrac

daysFrac

getDaysFrac

toString

toHumanReadableString

getStringRep

parseTimeValue

parseTimeValue

equals

hashCode

nsecToMSec

compareTo