ByteUtils (Apache Gora 0.7 API)

java.lang.Object
- org.apache.gora.util.ByteUtils

```
public class ByteUtils
extends Object
```
Utility class that handles byte arrays, conversions to/from other types.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`SIZEOF_BOOLEAN` Size of boolean in bytes
`static int`	`SIZEOF_BYTE` Size of byte in bytes
`static int`	`SIZEOF_CHAR` Size of char in bytes
`static int`	`SIZEOF_DOUBLE` Size of double in bytes
`static int`	`SIZEOF_FLOAT` Size of float in bytes
`static int`	`SIZEOF_INT` Size of int in bytes
`static int`	`SIZEOF_LONG` Size of long in bytes
`static int`	`SIZEOF_SHORT` Size of short in bytes

Constructor Summary

Constructors
Constructor and Description

ByteUtils()

Constructors
Constructor and Description
`ByteUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`bytesToVint(byte[] buffer)` Converts variable length byte array to it s int value representation.
`static long`	`bytesToVlong(byte[] buffer)` Converts variable length byte array to it s long value representation.
`static int`	`compareTo(byte[] left, byte[] right)` Compare byte two byte arrays, and returns a int value accordingly.
`static int`	`compareTo(byte[] b1, int s1, int l1, byte[] b2, int s2, int l2)` Compare byte two byte arrays given offset and length, and returns a int value accordingly.
`static boolean`	`equals(byte[] left, byte[] right)` Compare byte two byte arrays for equality, and returns a boolean value accordingly.
`static <T> T`	`fromBytes(byte[] val, org.apache.avro.Schema schema, org.apache.avro.specific.SpecificDatumReader<T> datumReader, T object)`
`static int`	`putByte(byte[] bytes, int offset, byte b)` Write a single byte out to the specified byte array position.
`static int`	`putBytes(byte[] tgtBytes, int tgtOffset, byte[] srcBytes, int srcOffset, int srcLength)` Put bytes at the specified byte array position.
`static long`	`readVLong(byte[] buffer, int offset)` Reads a zero-compressed encoded long from input stream and returns it.
`static boolean`	`toBoolean(byte[] b)` Convert a byte array to it s boolean value.
`static byte[]`	`toBytes(boolean b)` Convert a boolean to a byte array.
`static byte[]`	`toBytes(ByteBuffer bb)` Returns a new byte array, copied from the passed ByteBuffer.
`static byte[]`	`toBytes(char val)` Convert a char value to a byte array.
`static byte[]`	`toBytes(double d)` Converts double value to byte array.
`static byte[]`	`toBytes(float f)` Converts float value to it s byte array representation.
`static byte[]`	`toBytes(int val)` Convert an int value to a byte array.
`static byte[]`	`toBytes(long val)` Convert a long value to a byte array.
`static byte[]`	`toBytes(short val)` Convert a short value to a byte array.
`static byte[]`	`toBytes(String s)` Converts a string to a UTF-8 byte array.
`static <T> byte[]`	`toBytes(T o, org.apache.avro.Schema schema, org.apache.avro.specific.SpecificDatumWriter<T> datumWriter)`
`static char`	`toChar(byte[] bytes)` Converts a byte array to a char value.
`static char`	`toChar(byte[] bytes, int offset)` Converts a byte array to a char value.
`static char`	`toChar(byte[] bytes, int offset, int length)` Converts a byte array to a char value.
`static char[]`	`toChars(byte[] bytes)` Converts a byte array to a char array value.
`static char[]`	`toChars(byte[] bytes, int offset)` Converts a byte array to a char array value.
`static char[]`	`toChars(byte[] bytes, int offset, int length)` Converts a byte array to a char array value.
`static double`	`toDouble(byte[] bytes)` Converts byte array to a double value.
`static double`	`toDouble(byte[] bytes, int offset)` Converts byte array given offset to double value.
`static float`	`toFloat(byte[] bytes)` Presumes float encoded as IEEE 754 floating-point "single format".
`static float`	`toFloat(byte[] bytes, int offset)` Presumes float encoded as IEEE 754 floating-point "single format".
`static int`	`toInt(byte[] bytes)` Converts a byte array to an int value.
`static int`	`toInt(byte[] bytes, int offset)` Converts a byte array to an int value.
`static int`	`toInt(byte[] bytes, int offset, int length)` Converts a byte array to an int value.
`static long`	`toLong(byte[] bytes)` Converts a byte array to a long value.
`static long`	`toLong(byte[] bytes, int offset)` Converts a byte array to a long value.
`static long`	`toLong(byte[] bytes, int offset, int length)` Converts a byte array to a long value.
`static short`	`toShort(byte[] bytes)` Converts a byte array to a short value.
`static short`	`toShort(byte[] bytes, int offset)` Converts a byte array to a short value.
`static short`	`toShort(byte[] bytes, int offset, int length)` Converts a byte array to a short value.
`static String`	`toString(byte[] b)` Converts a byte array to it s String representation.
`static String`	`toString(byte[] b, int off, int len)` Converts byte array given offset and length to it s String representation.
`static String`	`toString(byte[] b1, String sep, byte[] b2)` Converts two byte array given a separator string in between to single String representation.
`static byte[]`	`vintToBytes(long vint)` Converts a int value to it s variable length byte array representation.

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

- Field Detail
  - SIZEOF_BOOLEAN
```
public static final int SIZEOF_BOOLEAN
```
    Size of boolean in bytes
    
    See Also:
    
    Constant Field Values
  - SIZEOF_BYTE
```
public static final int SIZEOF_BYTE
```
    Size of byte in bytes
    
    See Also:
    
    Constant Field Values
  - SIZEOF_CHAR
```
public static final int SIZEOF_CHAR
```
    Size of char in bytes
    
    See Also:
    
    Constant Field Values
  - SIZEOF_DOUBLE
```
public static final int SIZEOF_DOUBLE
```
    Size of double in bytes
    
    See Also:
    
    Constant Field Values
  - SIZEOF_FLOAT
```
public static final int SIZEOF_FLOAT
```
    Size of float in bytes
    
    See Also:
    
    Constant Field Values
  - SIZEOF_INT
```
public static final int SIZEOF_INT
```
    Size of int in bytes
    
    See Also:
    
    Constant Field Values
  - SIZEOF_LONG
```
public static final int SIZEOF_LONG
```
    Size of long in bytes
    
    See Also:
    
    Constant Field Values
  - SIZEOF_SHORT
```
public static final int SIZEOF_SHORT
```
    Size of short in bytes
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ByteUtils
```
public ByteUtils()
```
- Method Detail
  - putBytes
```
public static int putBytes(byte[] tgtBytes,
                           int tgtOffset,
                           byte[] srcBytes,
                           int srcOffset,
                           int srcLength)
```
    Put bytes at the specified byte array position.
    
    Parameters:
    
    tgtBytes - the byte array which source/input bytes are written.
    
    tgtOffset - offset position in the array to be considered to write bytes.
    
    srcBytes - source of byte to write out on target byte array.
    
    srcOffset - offset of source byte array to be considered.
    
    srcLength - length from offset of source byte array to be considered.
    
    Returns:
    
    incremented offset.
  - putByte
```
public static int putByte(byte[] bytes,
                          int offset,
                          byte b)
```
    Write a single byte out to the specified byte array position.
    
    Parameters:
    
    bytes - the byte array input.
    
    offset - position in the array.
    
    b - byte to write out.
    
    Returns:
    
    incremented offset.
  - toBytes
```
public static byte[] toBytes(ByteBuffer bb)
```
    Returns a new byte array, copied from the passed ByteBuffer.
    
    Parameters:
    
    bb - A ByteBuffer as input.
    
    Returns:
    
    the byte array of bb.
  - toString
```
public static String toString(byte[] b)
```
    Converts a byte array to it s String representation.
    
    Parameters:
    
    b - Presumed UTF-8 encoded byte array.
    
    Returns:
    
    String made from b.
  - toString
```
public static String toString(byte[] b1,
                              String sep,
                              byte[] b2)
```
    Converts two byte array given a separator string in between to single String representation.
    
    Parameters:
    
    b1 - Presumed UTF-8 encoded byte array input 1.
    
    b2 - Presumed UTF-8 encoded byte array input 2.
    
    sep - Separator String.
    
    Returns:
    
    String made from b1+sep+b2.
  - toString
```
public static String toString(byte[] b,
                              int off,
                              int len)
```
    Converts byte array given offset and length to it s String representation.
    
    Parameters:
    
    b - Presumed UTF-8 encoded byte array.
    
    off - offset to be from the input byte array.
    
    len - length to be considered from the offset.
    
    Returns:
    
    String made from b.
  - toBytes
```
public static byte[] toBytes(String s)
```
    Converts a string to a UTF-8 byte array.
    
    Parameters:
    
    s - input String value.
    
    Returns:
    
    the byte array.
  - toBytes
```
public static byte[] toBytes(boolean b)
```
    Convert a boolean to a byte array.
    
    Parameters:
    
    b - input boolean value.
    
    Returns:
    
    b encoded in a byte array.
  - toBoolean
```
public static boolean toBoolean(byte[] b)
```
    Convert a byte array to it s boolean value.
    
    Parameters:
    
    b - input byte array.
    
    Returns:
    
    boolean value either True or false.
  - toBytes
```
public static byte[] toBytes(long val)
```
    Convert a long value to a byte array.
    
    Parameters:
    
    val - input long value.
    
    Returns:
    
    the byte array.
  - toLong
```
public static long toLong(byte[] bytes)
```
    Converts a byte array to a long value.
    
    Parameters:
    
    bytes - input byte array.
    
    Returns:
    
    the long value.
  - toLong
```
public static long toLong(byte[] bytes,
                          int offset)
```
    Converts a byte array to a long value.
    
    Parameters:
    
    bytes - input byte array.
    
    offset - offset to be from the input byte array.
    
    Returns:
    
    the long value.
  - toLong
```
public static long toLong(byte[] bytes,
                          int offset,
                          int length)
```
    Converts a byte array to a long value.
    
    Parameters:
    
    bytes - input byte array.
    
    offset - offset to be from the input byte array.
    
    length - length to be considered from the offset.
    
    Returns:
    
    the long value.
  - toFloat
```
public static float toFloat(byte[] bytes)
```
    Presumes float encoded as IEEE 754 floating-point "single format".
    
    Parameters:
    
    bytes - offset to be considered from byte array.
    
    Returns:
    
    Float made from passed byte array.
  - toFloat
```
public static float toFloat(byte[] bytes,
                            int offset)
```
    Presumes float encoded as IEEE 754 floating-point "single format".
    
    Parameters:
    
    bytes - input byte array to be considered.
    
    offset - offset to be considered from byte array.
    
    Returns:
    
    Float made from passed byte array.
  - toBytes
```
public static byte[] toBytes(float f)
```
    Converts float value to it s byte array representation.
    
    Parameters:
    
    f - input float value.
    
    Returns:
    
    the float represented as byte [].
  - toDouble
```
public static double toDouble(byte[] bytes)
```
    Converts byte array to a double value.
    
    Parameters:
    
    bytes - input byte array to be considered.
    
    Returns:
    
    Return double made from passed bytes.
  - toDouble
```
public static double toDouble(byte[] bytes,
                              int offset)
```
    Converts byte array given offset to double value.
    
    Parameters:
    
    bytes - input byte array.
    
    offset - offset to be considered from input array.
    
    Returns:
    
    Return double made from passed bytes.
  - toBytes
```
public static byte[] toBytes(double d)
```
    Converts double value to byte array.
    
    Parameters:
    
    d - double input value.
    
    Returns:
    
    the double represented as byte [].
  - toBytes
```
public static byte[] toBytes(int val)
```
    Convert an int value to a byte array.
    
    Parameters:
    
    val - int input value.
    
    Returns:
    
    the byte array.
  - toInt
```
public static int toInt(byte[] bytes)
```
    Converts a byte array to an int value.
    
    Parameters:
    
    bytes - input byte array to be converted.
    
    Returns:
    
    the int value
  - toInt
```
public static int toInt(byte[] bytes,
                        int offset)
```
    Converts a byte array to an int value.
    
    Parameters:
    
    bytes - input byte array.
    
    offset - input byte array offset.
    
    Returns:
    
    the int value.
  - toInt
```
public static int toInt(byte[] bytes,
                        int offset,
                        int length)
```
    Converts a byte array to an int value.
    
    Parameters:
    
    bytes - input byte array.
    
    offset - input byte array offset.
    
    length - length from offset position.
    
    Returns:
    
    the int value.
  - toBytes
```
public static byte[] toBytes(short val)
```
    Convert a short value to a byte array.
    
    Parameters:
    
    val - input short value.
    
    Returns:
    
    the byte array.
  - toShort
```
public static short toShort(byte[] bytes)
```
    Converts a byte array to a short value.
    
    Parameters:
    
    bytes - input byte array.
    
    Returns:
    
    the short value.
  - toShort
```
public static short toShort(byte[] bytes,
                            int offset)
```
    Converts a byte array to a short value.
    
    Parameters:
    
    bytes - input byte array.
    
    offset - offset position of input array.
    
    Returns:
    
    the short value.
  - toShort
```
public static short toShort(byte[] bytes,
                            int offset,
                            int length)
```
    Converts a byte array to a short value.
    
    Parameters:
    
    bytes - input byte array.
    
    offset - offset position from input byte array.
    
    length - length to be considered from offset.
    
    Returns:
    
    the short value.
  - toBytes
```
public static byte[] toBytes(char val)
```
    Convert a char value to a byte array.
    
    Parameters:
    
    val - input char value.
    
    Returns:
    
    the byte array.
  - toChar
```
public static char toChar(byte[] bytes)
```
    Converts a byte array to a char value.
    
    Parameters:
    
    bytes - input bytes array.
    
    Returns:
    
    the char value.
  - toChar
```
public static char toChar(byte[] bytes,
                          int offset)
```
    Converts a byte array to a char value.
    
    Parameters:
    
    bytes - input bytes array.
    
    offset - offset to be considered from input array.
    
    Returns:
    
    the char value.
  - toChar
```
public static char toChar(byte[] bytes,
                          int offset,
                          int length)
```
    Converts a byte array to a char value.
    
    Parameters:
    
    bytes - input byte array.
    
    offset - offset to be considered from input array.
    
    length - length to be considered from offset.
    
    Returns:
    
    the char value.
  - toChars
```
public static char[] toChars(byte[] bytes)
```
    Converts a byte array to a char array value.
    
    Parameters:
    
    bytes - input byte array.
    
    Returns:
    
    the char value.
  - toChars
```
public static char[] toChars(byte[] bytes,
                             int offset)
```
    Converts a byte array to a char array value.
    
    Parameters:
    
    bytes - input byte array.
    
    offset - offset to be considered from input array.
    
    Returns:
    
    the char value.
  - toChars
```
public static char[] toChars(byte[] bytes,
                             int offset,
                             int length)
```
    Converts a byte array to a char array value.
    
    Parameters:
    
    bytes - input byte array.
    
    offset - offset to be considered from input array.
    
    length - length to be considered from offset.
    
    Returns:
    
    the char value.
  - vintToBytes
```
public static byte[] vintToBytes(long vint)
```
    Converts a int value to it s variable length byte array representation.
    
    Parameters:
    
    vint - Integer to make a vint of.
    
    Returns:
    
    Vint as bytes array.
  - bytesToVlong
```
public static long bytesToVlong(byte[] buffer)
```
    Converts variable length byte array to it s long value representation.
    
    Parameters:
    
    buffer - input byte array.
    
    Returns:
    
    vint bytes as an integer.
  - bytesToVint
```
public static int bytesToVint(byte[] buffer)
```
    Converts variable length byte array to it s int value representation.
    
    Parameters:
    
    buffer - input byte array.
    
    Returns:
    
    vint bytes as an integer.
  - readVLong
```
public static long readVLong(byte[] buffer,
                             int offset)
                      throws IOException
```
    Reads a zero-compressed encoded long from input stream and returns it.
    
    Parameters:
    
    buffer - Binary input array.
    
    offset - Offset into array at which vint begins.
    
    Returns:
    
    deserialized long from stream.
    
    Throws:
    
    IOException - when read error occurs while extracting data from input stream.
  - compareTo
```
public static int compareTo(byte[] left,
                            byte[] right)
```
    Compare byte two byte arrays, and returns a int value accordingly.
    
    Parameters:
    
    left - left byte array to be considered.
    
    right - right byte array to be considered.
    
    Returns:
    
    0 if equal, < 0 if left is less than right, etc.
  - compareTo
```
public static int compareTo(byte[] b1,
                            int s1,
                            int l1,
                            byte[] b2,
                            int s2,
                            int l2)
```
    Compare byte two byte arrays given offset and length, and returns a int value accordingly.
    
    Parameters:
    
    b1 - left byte array to be considered.
    
    b2 - right byte array to be considered.
    
    s1 - Where to start comparing in the left buffer.
    
    s2 - Where to start comparing in the right buffer.
    
    l1 - How much to compare from the left buffer.
    
    l2 - How much to compare from the right buffer.
    
    Returns:
    
    0 if equal, < 0 if left is less than right, etc.
  - equals
```
public static boolean equals(byte[] left,
                             byte[] right)
```
    Compare byte two byte arrays for equality, and returns a boolean value accordingly.
    
    Parameters:
    
    left - left byte array to be considered.
    
    right - right byte array to be considered.
    
    Returns:
    
    True if equal.
  - fromBytes
```
public static <T> T fromBytes(byte[] val,
                              org.apache.avro.Schema schema,
                              org.apache.avro.specific.SpecificDatumReader<T> datumReader,
                              T object)
                       throws IOException
```
    Throws:
    
    IOException
  - toBytes
```
public static <T> byte[] toBytes(T o,
                                 org.apache.avro.Schema schema,
                                 org.apache.avro.specific.SpecificDatumWriter<T> datumWriter)
                          throws IOException
```
    Throws:
    
    IOException

Class ByteUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SIZEOF_BOOLEAN

SIZEOF_BYTE

SIZEOF_CHAR

SIZEOF_DOUBLE

SIZEOF_FLOAT

SIZEOF_INT

SIZEOF_LONG

SIZEOF_SHORT

Constructor Detail

ByteUtils

Method Detail

putBytes

putByte

toBytes

toString

toString

toString

toBytes

toBytes

toBoolean

toBytes

toLong

toLong

toLong

toFloat

toFloat

toBytes

toDouble

toDouble

toBytes

toBytes

toInt

toInt

toInt

toBytes

toShort

toShort

toShort

toBytes

toChar

toChar

toChar

toChars

toChars

toChars

vintToBytes

bytesToVlong

bytesToVint

readVLong

compareTo

compareTo

equals

fromBytes

toBytes