Package org.elasticsearch.common.bytes

Class CompositeBytesReference

java.lang.Object

org.elasticsearch.common.bytes.BytesReference

org.elasticsearch.common.bytes.CompositeBytesReference

All Implemented Interfaces:

java.lang.Comparable<BytesReference>, ToXContent, ToXContentFragment

public final class CompositeBytesReference
extends BytesReference

A composite BytesReference that allows joining multiple bytes references into one without copying. Note, toBytesRef() will materialize all pages in this BytesReference.

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

Constructor Summary

Constructors

Constructor	Description
CompositeBytesReference(BytesReference... references)

Method Summary

Modifier and Type	Method	Description
byte	get(int index)	Returns the byte at the specified index.
org.apache.lucene.util.BytesRefIterator	iterator()	Returns a BytesRefIterator for this BytesReference.
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.
org.apache.lucene.util.BytesRef	toBytesRef()	Converts to Lucene BytesRef.

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

bytes, compareTo, equals, hashCode, streamInput, 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

Constructor Detail

CompositeBytesReference

public CompositeBytesReference(BytesReference... references)

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

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 org.apache.lucene.util.BytesRef toBytesRef()

Description copied from class: BytesReference

Converts to Lucene BytesRef.

Specified by:

toBytesRef in class BytesReference

iterator

public org.apache.lucene.util.BytesRefIterator iterator()

Description copied from class: BytesReference

Returns a BytesRefIterator for this BytesReference. This method allows access to the internal pages of this reference without copying them. Use with care!

Overrides:

iterator in class BytesReference

See Also:

BytesRefIterator

ramBytesUsed

public long ramBytesUsed()

Description copied from class: BytesReference

The amount of memory used by this BytesReference

Specified by:

ramBytesUsed in class BytesReference