org.apache.hadoop.hive.serde2.columnar

Class BytesRefWritable

java.lang.Object

org.apache.hadoop.hive.serde2.columnar.BytesRefWritable

All Implemented Interfaces:

java.lang.Comparable<BytesRefWritable>

public class BytesRefWritable
extends java.lang.Object
implements java.lang.Comparable<BytesRefWritable>

BytesRefWritable referenced a section of byte array. It can be used to avoid unnecessary byte copy.

Field Summary

Fields

Modifier and Type	Field and Description
static BytesRefWritable	ZeroBytesRefWritable

Constructor Summary

Constructors

Constructor and Description
BytesRefWritable() Create a zero-size bytes.
BytesRefWritable(byte[] bytes) Create a BytesRefWritable referenced to the given bytes.
BytesRefWritable(byte[] data, int offset, int len) Create a BytesRefWritable referenced to one section of the given bytes.
BytesRefWritable(int length) Create a BytesRefWritable with length bytes.
BytesRefWritable(LazyDecompressionCallback lazyDecompressData, int offset, int len) Create a BytesRefWritable referenced to one section of the given bytes.

Method Summary

Modifier and Type	Method and Description
int	compareTo(BytesRefWritable other)
boolean	equals(java.lang.Object right_obj)
byte[]	getBytesCopy() Returns a copy of the underlying bytes referenced by this instance.
byte[]	getData() Returns the underlying bytes.
int	getLength()
int	getStart()
int	hashCode()
void	readFields(java.io.DataInput in) Always reuse the bytes array if length of bytes array is equal or greater to the current record, otherwise create a new one.
void	set(byte[] newData, int offset, int len) readFields() will corrupt the array.
void	set(LazyDecompressionCallback newData, int offset, int len) readFields() will corrupt the array.
java.lang.String	toString()
void	write(java.io.DataOutput out)
void	writeDataTo(java.io.DataOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ZeroBytesRefWritable

public static BytesRefWritable ZeroBytesRefWritable

Constructor Detail

BytesRefWritable

public BytesRefWritable()

Create a zero-size bytes.

BytesRefWritable

public BytesRefWritable(int length)

Create a BytesRefWritable with length bytes.

BytesRefWritable

public BytesRefWritable(byte[] bytes)

Create a BytesRefWritable referenced to the given bytes.

BytesRefWritable

public BytesRefWritable(byte[] data,
                        int offset,
                        int len)

Create a BytesRefWritable referenced to one section of the given bytes. The section is determined by argument offset and len.

BytesRefWritable

public BytesRefWritable(LazyDecompressionCallback lazyDecompressData,
                        int offset,
                        int len)

Create a BytesRefWritable referenced to one section of the given bytes. The argument lazyDecompressData refers to a LazyDecompressionCallback object. The arguments offset and len are referred to uncompressed bytes of lazyDecompressData. Use offset and len after uncompressing the data.

Method Detail

getBytesCopy

public byte[] getBytesCopy()
                    throws java.io.IOException

Returns a copy of the underlying bytes referenced by this instance.

Returns:

a new copied byte array

Throws:

java.io.IOException

getData

public byte[] getData()
               throws java.io.IOException

Returns the underlying bytes.

Throws:

java.io.IOException

set

public void set(byte[] newData,
                int offset,
                int len)

readFields() will corrupt the array. So use the set method whenever possible.

See Also:

readFields(DataInput)

set

public void set(LazyDecompressionCallback newData,
                int offset,
                int len)

readFields() will corrupt the array. So use the set method whenever possible.

See Also:

readFields(DataInput)

writeDataTo

public void writeDataTo(java.io.DataOutput out)
                 throws java.io.IOException

Throws:

java.io.IOException

readFields

public void readFields(java.io.DataInput in)
                throws java.io.IOException

Always reuse the bytes array if length of bytes array is equal or greater to the current record, otherwise create a new one. readFields will corrupt the array. Please use set() whenever possible.

Throws:

java.io.IOException

See Also:

set(byte[], int, int)

write

public void write(java.io.DataOutput out)
           throws java.io.IOException

Throws:

java.io.IOException

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(BytesRefWritable other)

Specified by:

compareTo in interface java.lang.Comparable<BytesRefWritable>

equals

public boolean equals(java.lang.Object right_obj)

Overrides:

equals in class java.lang.Object

getLength

public int getLength()

getStart

public int getStart()