TimeRange (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.io.TimeRange

```
@InterfaceAudience.Public
@InterfaceStability.Stable
public class TimeRange
extends Object
```
Represents an interval of version timestamps.
Evaluated according to minStamp <= timestamp < maxStamp or [minStamp,maxStamp) in interval notation.
Only used internally; should not be accessed directly by clients.

Field Summary

Fields
Modifier and Type Field and Description

private boolean allTime

private long maxStamp

private long minStamp

Fields
Modifier and Type	Field and Description
`private boolean`	`allTime`
`private long`	`maxStamp`
`private long`	`minStamp`

Constructor Summary

Constructors
Constructor and Description
`TimeRange()` Deprecated. This is made @InterfaceAudience.Private in the 2.0 line and above
`TimeRange(byte[] minStamp)` Deprecated. This is removed in the 2.0 line and above
`TimeRange(byte[] minStamp, byte[] maxStamp)` Deprecated. This is removed in the 2.0 line and above
`TimeRange(long minStamp)` Deprecated. This is made @InterfaceAudience.Private in the 2.0 line and above
`TimeRange(long minStamp, long maxStamp)` Deprecated. This is made @InterfaceAudience.Private in the 2.0 line and above

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compare(long timestamp)` Compare the timestamp to timerange
`long`	`getMax()`
`long`	`getMin()`
`boolean`	`isAllTime()` Check if it is for all time
`String`	`toString()`
`boolean`	`withinOrAfterTimeRange(long timestamp)` Check if the specified timestamp is within this TimeRange.
`boolean`	`withinTimeRange(byte[] bytes, int offset)` Check if the specified timestamp is within this TimeRange.
`boolean`	`withinTimeRange(long timestamp)` Check if the specified timestamp is within this TimeRange.

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

- Field Detail
  - minStamp
```
private long minStamp
```
  - maxStamp
```
private long maxStamp
```
  - allTime
```
private boolean allTime
```
- Constructor Detail
  - TimeRange
```
@Deprecated
public TimeRange()
```
    Deprecated. This is made @InterfaceAudience.Private in the 2.0 line and above
    
    Default constructor. Represents interval [0, Long.MAX_VALUE) (allTime)
  - TimeRange
```
@Deprecated
public TimeRange(long minStamp)
```
    Deprecated. This is made @InterfaceAudience.Private in the 2.0 line and above
    
    Represents interval [minStamp, Long.MAX_VALUE)
    
    Parameters:
    minStamp - the minimum timestamp value, inclusive
  - TimeRange
```
@Deprecated
public TimeRange(byte[] minStamp)
```
    Deprecated. This is removed in the 2.0 line and above
    
    Represents interval [minStamp, Long.MAX_VALUE)
    
    Parameters:
    minStamp - the minimum timestamp value, inclusive
  - TimeRange
```
@Deprecated
public TimeRange(long minStamp,
                    long maxStamp)
          throws IOException
```
    Deprecated. This is made @InterfaceAudience.Private in the 2.0 line and above
    
    Represents interval [minStamp, maxStamp)
    
    Parameters:
    minStamp - the minimum timestamp, inclusive
    maxStamp - the maximum timestamp, exclusive
    
    Throws:
    
    IllegalArgumentException - if either <0,
    
    IOException - if max smaller than min.
  - TimeRange
```
@Deprecated
public TimeRange(byte[] minStamp,
                    byte[] maxStamp)
          throws IOException
```
    Deprecated. This is removed in the 2.0 line and above
    
    Represents interval [minStamp, maxStamp)
    
    Parameters:
    minStamp - the minimum timestamp, inclusive
    maxStamp - the maximum timestamp, exclusive
    
    Throws:
    
    IOException
- Method Detail
  - getMin
```
public long getMin()
```
    Returns:
    the smallest timestamp that should be considered
  - getMax
```
public long getMax()
```
    Returns:
    the biggest timestamp that should be considered
  - isAllTime
```
public boolean isAllTime()
```
    Check if it is for all time
    
    Returns:
    true if it is for all time
  - withinTimeRange
```
public boolean withinTimeRange(byte[] bytes,
                      int offset)
```
    Check if the specified timestamp is within this TimeRange.
    Returns true if within interval [minStamp, maxStamp), false if not.
    
    Parameters:
    bytes - timestamp to check
    offset - offset into the bytes
    
    Returns:
    true if within TimeRange, false if not
  - withinTimeRange
```
public boolean withinTimeRange(long timestamp)
```
    Check if the specified timestamp is within this TimeRange.
    Returns true if within interval [minStamp, maxStamp), false if not.
    
    Parameters:
    timestamp - timestamp to check
    
    Returns:
    true if within TimeRange, false if not
  - withinOrAfterTimeRange
```
public boolean withinOrAfterTimeRange(long timestamp)
```
    Check if the specified timestamp is within this TimeRange.
    Returns true if within interval [minStamp, maxStamp), false if not.
    
    Parameters:
    timestamp - timestamp to check
    
    Returns:
    true if within TimeRange, false if not
  - compare
```
public int compare(long timestamp)
```
    Compare the timestamp to timerange
    
    Parameters:
    timestamp -
    
    Returns:
    -1 if timestamp is less than timerange, 0 if timestamp is within timerange, 1 if timestamp is greater than timerange
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TimeRange

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

minStamp

maxStamp

allTime

Constructor Detail

TimeRange

TimeRange

TimeRange

TimeRange

TimeRange

Method Detail

getMin

getMax

isAllTime

withinTimeRange

withinTimeRange

withinOrAfterTimeRange

compare

toString