Module org.elasticsearch.server

Package org.elasticsearch.common.bytes

Class PagedBytesReference

java.lang.Object

org.elasticsearch.common.bytes.AbstractBytesReference

org.elasticsearch.common.bytes.PagedBytesReference

All Implemented Interfaces:

Comparable<BytesReference>, BytesReference, ToXContent, ToXContentFragment

public class PagedBytesReference
extends AbstractBytesReference

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.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.common.bytes.AbstractBytesReference

length

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

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

compareTo, equals, getDoubleLE, getInt, getIntLE, getLongLE, hashCode, indexOf, length, streamInput, 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.bytes.BytesReference

array, arrayOffset, hasArray

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Method Details

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.

slice

public BytesReference slice(int from,
 int length)

Description copied from interface: BytesReference

Slice the bytes from the from index up to length.

toBytesRef

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

Description copied from interface: BytesReference

Converts to Lucene BytesRef.

iterator

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

Description copied from interface: BytesReference

Returns a BytesRefIterator for this BytesReference. This method allows access to the internal pages of this reference without copying them. It must return direct references to the pages, not copies. Use with care!

See Also:

• BytesRefIterator

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: BytesReference

The amount of memory used by this BytesReference