org.elasticsearch.common.bytes

Class PagedBytesReference

java.lang.Object

org.elasticsearch.common.bytes.PagedBytesReference

All Implemented Interfaces:

BytesReference

Direct Known Subclasses:

ReleasablePagedBytesReference

public class PagedBytesReference
extends Object
implements BytesReference

A page based bytes reference, internally holding the bytes in a paged data structure.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.bytes.BytesReference

BytesReference.Helper

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteArray	bytearray

Constructor Summary

Constructors

Constructor and Description
PagedBytesReference(BigArrays bigarrays, ByteArray bytearray, int length)
PagedBytesReference(BigArrays bigarrays, ByteArray bytearray, int from, int length)

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	array() The underlying byte array (if exists).
int	arrayOffset() The offset into the underlying byte array.
BytesArray	copyBytesArray() Returns the bytes copied over as a byte array.
org.apache.lucene.util.BytesRef	copyBytesRef() Converts to a copied Lucene BytesRef.
boolean	equals(Object obj)
byte	get(int index) Returns the byte at the specified index.
boolean	hasArray() Is there an underlying byte array for this bytes reference.
int	hashCode()
int	length() The length.
BytesReference	slice(int from, int length) Slice the bytes from the from index up to length.
StreamInput	streamInput() A stream input of the bytes.
byte[]	toBytes() Returns the bytes as a single byte array.
BytesArray	toBytesArray() Returns the bytes as a byte array, possibly sharing the underlying byte buffer.
org.apache.lucene.util.BytesRef	toBytesRef() Converts to Lucene BytesRef.
org.jboss.netty.buffer.ChannelBuffer	toChannelBuffer() Returns the bytes as a channel buffer.
String	toUtf8() Converts to a string based on utf8.
void	writeTo(GatheringByteChannel channel) Writes the bytes directly to the channel.
void	writeTo(OutputStream os) Writes the bytes directly to the output stream.

Methods inherited from class java.lang.Object

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

Field Detail

bytearray

protected final ByteArray bytearray

Constructor Detail

PagedBytesReference

public PagedBytesReference(BigArrays bigarrays,
                   ByteArray bytearray,
                   int length)

PagedBytesReference

public PagedBytesReference(BigArrays bigarrays,
                   ByteArray bytearray,
                   int from,
                   int length)

Method Detail

get

public byte get(int index)

Description copied from interface: BytesReference

Returns the byte at the specified index. Need to be between 0 and length.

Specified by:

get in interface BytesReference

length

public int length()

Description copied from interface: BytesReference

The length.

Specified by:

length in interface BytesReference

slice

public BytesReference slice(int from,
                   int length)

Description copied from interface: BytesReference

Slice the bytes from the from index up to length.

Specified by:

slice in interface BytesReference

streamInput

public StreamInput streamInput()

Description copied from interface: BytesReference

A stream input of the bytes.

Specified by:

streamInput in interface BytesReference

writeTo

public void writeTo(OutputStream os)
             throws IOException

Description copied from interface: BytesReference

Writes the bytes directly to the output stream.

Specified by:

writeTo in interface BytesReference

Throws:

IOException

writeTo

public void writeTo(GatheringByteChannel channel)
             throws IOException

Description copied from interface: BytesReference

Writes the bytes directly to the channel.

Specified by:

writeTo in interface BytesReference

Throws:

IOException

toBytes

public byte[] toBytes()

Description copied from interface: BytesReference

Returns the bytes as a single byte array.

Specified by:

toBytes in interface BytesReference

toBytesArray

public BytesArray toBytesArray()

Description copied from interface: BytesReference

Returns the bytes as a byte array, possibly sharing the underlying byte buffer.

Specified by:

toBytesArray in interface BytesReference

copyBytesArray

public BytesArray copyBytesArray()

Description copied from interface: BytesReference

Returns the bytes copied over as a byte array.

Specified by:

copyBytesArray in interface BytesReference

toChannelBuffer

public org.jboss.netty.buffer.ChannelBuffer toChannelBuffer()

Description copied from interface: BytesReference

Returns the bytes as a channel buffer.

Specified by:

toChannelBuffer in interface BytesReference

hasArray

public boolean hasArray()

Description copied from interface: BytesReference

Is there an underlying byte array for this bytes reference.

Specified by:

hasArray in interface BytesReference

array

public byte[] array()

Description copied from interface: BytesReference

The underlying byte array (if exists).

Specified by:

array in interface BytesReference

arrayOffset

public int arrayOffset()

Description copied from interface: BytesReference

The offset into the underlying byte array.

Specified by:

arrayOffset in interface BytesReference

toUtf8

public String toUtf8()

Description copied from interface: BytesReference

Converts to a string based on utf8.

Specified by:

toUtf8 in interface BytesReference

toBytesRef

public org.apache.lucene.util.BytesRef toBytesRef()

Description copied from interface: BytesReference

Converts to Lucene BytesRef.

Specified by:

toBytesRef in interface BytesReference

copyBytesRef

public org.apache.lucene.util.BytesRef copyBytesRef()

Description copied from interface: BytesReference

Converts to a copied Lucene BytesRef.

Specified by:

copyBytesRef in interface BytesReference

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object