Package org.elasticsearch.common.bytes

Class ByteBufferReference

java.lang.Object

org.elasticsearch.common.bytes.BytesReference

org.elasticsearch.common.bytes.ByteBufferReference

All Implemented Interfaces:

Comparable<BytesReference>, ToXContent, ToXContentFragment

public class ByteBufferReference
extends BytesReference

This is a BytesReference backed by a ByteBuffer. The byte buffer can either be a heap or direct byte buffer. The reference is composed of the space between the Buffer.position() and Buffer.limit() at construction time. If the position or limit of the underlying byte buffer is changed, those changes will not be reflected in this reference. Any changes to the underlying data in the byte buffer will be reflected in this reference.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
byte	get(int index)	Returns the byte at the specified index.
int	getInt(int index)	Returns the integer read from the 4 bytes (BE) starting at the given index.
int	length()	The length.
long	ramBytesUsed()	The amount of memory used by this BytesReference
BytesReference	slice(int from, int length)	Slice the bytes from the from index up to length.
BytesRef	toBytesRef()	This will return a bytes ref composed of the bytes.

Methods inherited from class org.elasticsearch.common.bytes.BytesReference

bytes, compareTo, equals, fromByteBuffers, hashCode, indexOf, iterator, streamInput, toByteBuffers, toBytes, toXContent, utf8ToString, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Method Detail

get

public byte get(int index)

Description copied from class: BytesReference

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

Specified by:

get in class BytesReference

getInt

public int getInt(int index)

Description copied from class: BytesReference

Returns the integer read from the 4 bytes (BE) starting at the given index.

Overrides:

getInt in class BytesReference

length

public int length()

Description copied from class: BytesReference

The length.

Specified by:

length in class BytesReference

slice

public BytesReference slice(int from,
                            int length)

Description copied from class: BytesReference

Slice the bytes from the from index up to length.

Specified by:

slice in class BytesReference

toBytesRef

public BytesRef toBytesRef()

This will return a bytes ref composed of the bytes. If this is a direct byte buffer, the bytes will have to be copied.

Specified by:

toBytesRef in class BytesReference

Returns:

the bytes ref

ramBytesUsed

public long ramBytesUsed()

Description copied from class: BytesReference

The amount of memory used by this BytesReference

Specified by:

ramBytesUsed in class BytesReference