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
public final class CompositeBytesReference extends AbstractBytesReference
A composite BytesReference that allows joining multiple bytes references into one without copying. Note, toBytesRef() will materialize all pages in this BytesReference.

  • Method Details

    • of

      public static BytesReference of(BytesReference... references)

    • 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.

    • indexOf

      public int indexOf(byte marker, int from)
      Description copied from interface: BytesReference
      Finds the index of the first occurrence of the given marker between within the given bounds.
      Specified by:
      indexOf in interface BytesReference
      Overrides:
      indexOf in class AbstractBytesReference
      Parameters:
      marker - marker byte to search
      from - lower bound for the index to check (inclusive)
      Returns:
      first index of the marker or -1 if not found

    • 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 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

    • writeTo

      public void writeTo(OutputStream os) throws IOException
      Description copied from interface: BytesReference
      Writes the bytes directly to the output stream.
      Specified by:
      writeTo in interface BytesReference
      Overrides:
      writeTo in class AbstractBytesReference
      Throws:
      IOException

    • ramBytesUsed

      public long ramBytesUsed()
      Description copied from interface: BytesReference
      The amount of memory used by this BytesReference

    • getIntLE

      public int getIntLE(int index)
      Description copied from interface: BytesReference
      Returns the integer read from the 4 bytes (LE) starting at the given index.
      Specified by:
      getIntLE in interface BytesReference
      Overrides:
      getIntLE in class AbstractBytesReference

    • getLongLE

      public long getLongLE(int index)
      Description copied from interface: BytesReference
      Returns the long read from the 8 bytes (LE) starting at the given index.
      Specified by:
      getLongLE in interface BytesReference
      Overrides:
      getLongLE in class AbstractBytesReference

    • getDoubleLE

      public double getDoubleLE(int index)
      Description copied from interface: BytesReference
      Returns the double read from the 8 bytes (LE) starting at the given index.
      Specified by:
      getDoubleLE in interface BytesReference
      Overrides:
      getDoubleLE in class AbstractBytesReference