Package org.elasticsearch.common.bytes

Class BytesArray

java.lang.Object
org.elasticsearch.common.bytes.AbstractBytesReference
org.elasticsearch.common.bytes.BytesArray
All Implemented Interfaces:
Comparable<BytesReference>, BytesReference, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentFragment
public final class BytesArray extends AbstractBytesReference

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final BytesArray
    EMPTY
     

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    BytesArray(byte[] bytes)
     
    BytesArray(byte[] bytes, int offset, int length)
     
    BytesArray(String bytes)
     
    BytesArray(org.apache.lucene.util.BytesRef bytesRef)
     
    BytesArray(org.apache.lucene.util.BytesRef bytesRef, boolean deepCopy)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    byte[]
    array()
     
    int
    arrayOffset()
     
    boolean
    equals(Object other)
     
    byte
    get(int index)
    Returns the byte at the specified index.
    boolean
    hasArray()
     
    int
    hashCode()
     
    int
    indexOf(byte marker, int from)
    Finds the index of the first occurrence of the given marker between within the given bounds.
    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.
    StreamInput
    streamInput()
    A stream input of the bytes.
    org.apache.lucene.util.BytesRef
    toBytesRef()
    Converts to Lucene BytesRef.
    void
    writeTo(OutputStream os)
    Writes the bytes directly to the output stream.

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

    compareTo, getInt, iterator, toXContent, utf8ToString

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

    isFragment

  • Field Details

  • Constructor Details

    • BytesArray

      public BytesArray(String bytes)

    • BytesArray

      public BytesArray(org.apache.lucene.util.BytesRef bytesRef)

    • BytesArray

      public BytesArray(org.apache.lucene.util.BytesRef bytesRef, boolean deepCopy)

    • BytesArray

      public BytesArray(byte[] bytes)

    • BytesArray

      public BytesArray(byte[] bytes, int offset, int length)

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

    • 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

    • length

      public int length()
      Description copied from interface: BytesReference
      The length.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AbstractBytesReference

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class AbstractBytesReference

    • slice

      public BytesReference slice(int from, int length)
      Description copied from interface: BytesReference
      Slice the bytes from the from index up to length.

    • hasArray

      public boolean hasArray()
      Returns:
      true if this instance is backed by a byte array

    • array

      public byte[] array()
      Returns:
      backing byte array for this instance

    • arrayOffset

      public int arrayOffset()
      Returns:
      offset of the first byte of this instance in the backing byte array

    • toBytesRef

      public org.apache.lucene.util.BytesRef toBytesRef()
      Description copied from interface: BytesReference
      Converts to Lucene BytesRef.

    • ramBytesUsed

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

    • streamInput

      public StreamInput streamInput()
      Description copied from interface: BytesReference
      A stream input of the bytes.
      Specified by:
      streamInput in interface BytesReference
      Overrides:
      streamInput in class AbstractBytesReference

    • 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