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
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentFragment
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.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params
-
Field Summary
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Method Summary
Modifier and TypeMethodDescriptionbyte
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
The amount of memory used by this BytesReferenceslice(int from, int length)
Slice the bytes from thefrom
index up tolength
.org.apache.lucene.util.BytesRef
Converts to Lucene BytesRef.Methods inherited from class org.elasticsearch.common.bytes.AbstractBytesReference
compareTo, equals, getInt, hashCode, indexOf, 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.common.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. -
length
public int length()Description copied from interface:BytesReference
The length. -
slice
Description copied from interface:BytesReference
Slice the bytes from thefrom
index up tolength
. -
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. Use with care!- Specified by:
iterator
in interfaceBytesReference
- Overrides:
iterator
in classAbstractBytesReference
- See Also:
BytesRefIterator
-
ramBytesUsed
public long ramBytesUsed()Description copied from interface:BytesReference
The amount of memory used by this BytesReference
-