Module org.elasticsearch.server
Package org.elasticsearch.common.bytes
Class CompositeBytesReference
java.lang.Object
org.elasticsearch.common.bytes.AbstractBytesReference
org.elasticsearch.common.bytes.CompositeBytesReference
- All Implemented Interfaces:
Comparable<BytesReference>,BytesReference,ToXContent,ToXContentFragment
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.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params -
Field Summary
Fields inherited from class org.elasticsearch.common.bytes.AbstractBytesReference
lengthFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Method Summary
Modifier and TypeMethodDescriptionbyteget(int index) Returns the byte at the specified index.doublegetDoubleLE(int index) Returns the double read from the 8 bytes (LE) starting at the given index.intgetIntLE(int index) Returns the integer read from the 4 bytes (LE) starting at the given index.longgetLongLE(int index) Returns the long read from the 8 bytes (LE) starting at the given index.intindexOf(byte marker, int from) Finds the index of the first occurrence of the given marker between within the given bounds.org.apache.lucene.util.BytesRefIteratoriterator()Returns a BytesRefIterator for this BytesReference.static BytesReferenceof(BytesReference... references) longThe amount of memory used by this BytesReferenceslice(int from, int length) Slice the bytes from thefromindex up tolength.org.apache.lucene.util.BytesRefConverts to Lucene BytesRef.voidwriteTo(OutputStream os) Writes the bytes directly to the output stream.Methods inherited from class org.elasticsearch.common.bytes.AbstractBytesReference
compareTo, equals, getInt, hashCode, length, streamInput, toXContent, utf8ToStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.common.bytes.BytesReference
array, arrayOffset, hasArrayMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Method Details
-
of
-
get
public byte get(int index) Description copied from interface:BytesReferenceReturns the byte at the specified index. Need to be between 0 and length. -
indexOf
public int indexOf(byte marker, int from) Description copied from interface:BytesReferenceFinds the index of the first occurrence of the given marker between within the given bounds.- Specified by:
indexOfin interfaceBytesReference- Overrides:
indexOfin classAbstractBytesReference- Parameters:
marker- marker byte to searchfrom- lower bound for the index to check (inclusive)- Returns:
- first index of the marker or
-1if not found
-
slice
Description copied from interface:BytesReferenceSlice the bytes from thefromindex up tolength. -
toBytesRef
public org.apache.lucene.util.BytesRef toBytesRef()Description copied from interface:BytesReferenceConverts to Lucene BytesRef. -
iterator
public org.apache.lucene.util.BytesRefIterator iterator()Description copied from interface:BytesReferenceReturns 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:
-
writeTo
Description copied from interface:BytesReferenceWrites the bytes directly to the output stream.- Specified by:
writeToin interfaceBytesReference- Overrides:
writeToin classAbstractBytesReference- Throws:
IOException
-
ramBytesUsed
public long ramBytesUsed()Description copied from interface:BytesReferenceThe amount of memory used by this BytesReference -
getIntLE
public int getIntLE(int index) Description copied from interface:BytesReferenceReturns the integer read from the 4 bytes (LE) starting at the given index.- Specified by:
getIntLEin interfaceBytesReference- Overrides:
getIntLEin classAbstractBytesReference
-
getLongLE
public long getLongLE(int index) Description copied from interface:BytesReferenceReturns the long read from the 8 bytes (LE) starting at the given index.- Specified by:
getLongLEin interfaceBytesReference- Overrides:
getLongLEin classAbstractBytesReference
-
getDoubleLE
public double getDoubleLE(int index) Description copied from interface:BytesReferenceReturns the double read from the 8 bytes (LE) starting at the given index.- Specified by:
getDoubleLEin interfaceBytesReference- Overrides:
getDoubleLEin classAbstractBytesReference
-