RelativeTime (kairosclient 3.1.1 API)

java.lang.Object
- org.kairosdb.client.builder.RelativeTime

public class RelativeTime
extends Object

A time unit relative to now.

Constructor Summary

Constructors
Constructor Description

RelativeTime()

RelativeTime(int value, TimeUnit unit)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`long`	`getTimeRelativeTo(long time)`	Returns the time in milliseconds relative to the specified time.
`String`	`getUnit()`	The unit of time.
`int`	`getValue()`	The time's value.
`int`	`hashCode()`
`String`	`toString()`

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

- Constructor Detail
  - RelativeTime
```
public RelativeTime()
```
  - RelativeTime
```
public RelativeTime(int value,
                    TimeUnit unit)
```
- Method Detail
  - getValue
```
public int getValue()
```
    The time's value.
    
    Returns:
    
    time value
  - getUnit
```
public String getUnit()
```
    The unit of time.
    
    Returns:
    
    time unit
  - getTimeRelativeTo
```
public long getTimeRelativeTo(long time)
```
    Returns the time in milliseconds relative to the specified time. For example, if this object is set to 3 days, this method returns 3 days from time.
    
    Parameters:
    
    time - time to calculate the relative time.
    
    Returns:
    
    time in milliseconds relative to the specified time
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object