ByteBufferReference (server 6.6.2 API)

java.lang.Object
- org.elasticsearch.common.bytes.BytesReference
- - org.elasticsearch.common.bytes.ByteBufferReference

All Implemented Interfaces:

java.lang.Comparable<BytesReference>, ToXContent, ToXContentFragment
```
public class ByteBufferReference
extends BytesReference
```
This is a BytesReference backed by a ByteBuffer. The byte buffer can either be a heap or direct byte buffer. The reference is composed of the space between the ByteBuffer.position(int) and ByteBuffer.limit(int) at construction time. If the position or limit of the underlying byte buffer is changed, those changes will not be reflected in this reference. However, modifying the limit or position of the underlying byte buffer is not recommended as those can be used during ByteBuffer.get() bounds checks. Use ByteBuffer.duplicate() at creation time if you plan on modifying the markers of the underlying byte buffer. Any changes to the underlying data in the byte buffer will be reflected.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
  ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary
- Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
  EMPTY_PARAMS

Constructor Summary

Constructors
Constructor Description

ByteBufferReference(java.nio.ByteBuffer buffer)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`byte`	`get(int index)`	Returns the byte at the specified index.
`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`.
`org.apache.lucene.util.BytesRef`	`toBytesRef()`	This will return a bytes ref composed of the bytes.

Methods inherited from class org.elasticsearch.common.bytes.BytesReference
bytes, compareTo, equals, hashCode, iterator, streamInput, toBytes, 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.xcontent.ToXContentFragment
isFragment

- Constructor Detail
  - ByteBufferReference
```
public ByteBufferReference(java.nio.ByteBuffer buffer)
```
- Method Detail
  - get
```
public byte get(int index)
```
    Description copied from class: BytesReference
    
    Returns the byte at the specified index. Need to be between 0 and length.
    
    Specified by:
    
    get in class BytesReference
  - length
```
public int length()
```
    Description copied from class: BytesReference
    
    The length.
    
    Specified by:
    
    length in class BytesReference
  - slice
```
public BytesReference slice(int from,
                            int length)
```
    Description copied from class: BytesReference
    
    Slice the bytes from the from index up to length.
    
    Specified by:
    
    slice in class BytesReference
  - toBytesRef
```
public org.apache.lucene.util.BytesRef toBytesRef()
```
    This will return a bytes ref composed of the bytes. If this is a direct byte buffer, the bytes will have to be copied.
    
    Specified by:
    
    toBytesRef in class BytesReference
    
    Returns:
    
    the bytes ref
  - ramBytesUsed
```
public long ramBytesUsed()
```
    Description copied from class: BytesReference
    
    The amount of memory used by this BytesReference
    
    Specified by:
    
    ramBytesUsed in class BytesReference