org.apache.hadoop.hbase.types
Class OrderedInt32

java.lang.Object
  extended by org.apache.hadoop.hbase.types.OrderedBytesBase<Integer>
      extended by org.apache.hadoop.hbase.types.OrderedInt32
All Implemented Interfaces:
DataType<Integer>

@InterfaceAudience.Public
@InterfaceStability.Evolving
public class OrderedInt32
extends OrderedBytesBase<Integer>

An int of 32-bits using a fixed-length encoding. Built on OrderedBytes.encodeInt32(PositionedByteRange, int, Order).


Field Summary
static OrderedInt32 ASCENDING
           
static OrderedInt32 DESCENDING
           
 
Fields inherited from class org.apache.hadoop.hbase.types.OrderedBytesBase
order
 
Constructor Summary
protected OrderedInt32(Order order)
           
 
Method Summary
 Integer decode(PositionedByteRange src)
          Read an instance of T from the buffer src.
 int decodeInt(PositionedByteRange src)
          Read an int value from the buffer src.
 int encode(PositionedByteRange dst, Integer val)
          Write instance val into buffer dst.
 Class<Integer> encodedClass()
          Inform consumers over what type this DataType operates.
 int encodedLength(Integer val)
          Inform consumers how long the encoded byte[] will be.
 int encodeInt(PositionedByteRange dst, int val)
          Write instance val into buffer dst.
 boolean isNullable()
          Indicates whether this instance supports encoding null values.
 
Methods inherited from class org.apache.hadoop.hbase.types.OrderedBytesBase
getOrder, isOrderPreserving, isSkippable, skip
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ASCENDING

public static final OrderedInt32 ASCENDING

DESCENDING

public static final OrderedInt32 DESCENDING
Constructor Detail

OrderedInt32

protected OrderedInt32(Order order)
Method Detail

isNullable

public boolean isNullable()
Description copied from interface: DataType
Indicates whether this instance supports encoding null values. This depends on the implementation details of the encoding format. All DataTypes that support null should treat null as comparing less than any non-null value for default sort ordering purposes.

Specified by:
isNullable in interface DataType<Integer>
Overrides:
isNullable in class OrderedBytesBase<Integer>
Returns:
true when null is supported, false otherwise.

encodedLength

public int encodedLength(Integer val)
Description copied from interface: DataType
Inform consumers how long the encoded byte[] will be.

Parameters:
val - The value to check.
Returns:
the number of bytes required to encode val.a

encodedClass

public Class<Integer> encodedClass()
Description copied from interface: DataType
Inform consumers over what type this DataType operates. Useful when working with bare DataType instances.


decode

public Integer decode(PositionedByteRange src)
Description copied from interface: DataType
Read an instance of T from the buffer src.

Parameters:
src - the buffer containing the encoded value.

encode

public int encode(PositionedByteRange dst,
                  Integer val)
Description copied from interface: DataType
Write instance val into buffer dst.

Parameters:
dst - the buffer containing the encoded value.
val - the value to encode onto dst.
Returns:
number of bytes written.

decodeInt

public int decodeInt(PositionedByteRange src)
Read an int value from the buffer src.


encodeInt

public int encodeInt(PositionedByteRange dst,
                     int val)
Write instance val into buffer dst.



Copyright © 2015 The Apache Software Foundation. All rights reserved.