PagedBytesReference (Elasticsearch: Core 2.3.5.1 API)

java.lang.Object
- org.elasticsearch.common.bytes.PagedBytesReference

すべての実装されたインタフェース:

BytesReference

直系の既知のサブクラス:

ReleasablePagedBytesReference
```
public class PagedBytesReference
extends Object
implements BytesReference
```
A page based bytes reference, internally holding the bytes in a paged data structure.

ネストされたクラスのサマリー
- インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.common.bytes.BytesReference
  BytesReference.Helper

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

protected ByteArray bytearray

フィールド
修飾子とタイプ	フィールドと説明
`protected ByteArray`	`bytearray`

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`PagedBytesReference(BigArrays bigarrays, ByteArray bytearray, int length)`
`PagedBytesReference(BigArrays bigarrays, ByteArray bytearray, int from, int length)`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`byte[]`	`array()` The underlying byte array (if exists).
`int`	`arrayOffset()` The offset into the underlying byte array.
`BytesArray`	`copyBytesArray()` Returns the bytes copied over as a byte array.
`org.apache.lucene.util.BytesRef`	`copyBytesRef()` Converts to a copied Lucene BytesRef.
`boolean`	`equals(Object obj)`
`byte`	`get(int index)` Returns the byte at the specified index.
`boolean`	`hasArray()` Is there an underlying byte array for this bytes reference.
`int`	`hashCode()`
`int`	`length()` The length.
`BytesReference`	`slice(int from, int length)` Slice the bytes from the `from` index up to `length`.
`StreamInput`	`streamInput()` A stream input of the bytes.
`byte[]`	`toBytes()` Returns the bytes as a single byte array.
`BytesArray`	`toBytesArray()` Returns the bytes as a byte array, possibly sharing the underlying byte buffer.
`org.apache.lucene.util.BytesRef`	`toBytesRef()` Converts to Lucene BytesRef.
`org.jboss.netty.buffer.ChannelBuffer`	`toChannelBuffer()` Returns the bytes as a channel buffer.
`String`	`toUtf8()` Converts to a string based on utf8.
`void`	`writeTo(GatheringByteChannel channel)` Writes the bytes directly to the channel.
`void`	`writeTo(OutputStream os)` Writes the bytes directly to the output stream.

クラスから継承されたメソッド java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - bytearray
```
protected final ByteArray bytearray
```
- コンストラクタの詳細
  - PagedBytesReference
```
public PagedBytesReference(BigArrays bigarrays,
                           ByteArray bytearray,
                           int length)
```
  - PagedBytesReference
```
public PagedBytesReference(BigArrays bigarrays,
                           ByteArray bytearray,
                           int from,
                           int length)
```
- メソッドの詳細
  - get
```
public byte get(int index)
```
    インタフェースからコピーされた説明: BytesReference
    
    Returns the byte at the specified index. Need to be between 0 and length.
    
    定義:
    
    get インタフェース内 BytesReference
  - length
```
public int length()
```
    インタフェースからコピーされた説明: BytesReference
    
    The length.
    
    定義:
    
    length インタフェース内 BytesReference
  - slice
```
public BytesReference slice(int from,
                            int length)
```
    インタフェースからコピーされた説明: BytesReference
    
    Slice the bytes from the from index up to length.
    
    定義:
    
    slice インタフェース内 BytesReference
  - streamInput
```
public StreamInput streamInput()
```
    インタフェースからコピーされた説明: BytesReference
    
    A stream input of the bytes.
    
    定義:
    
    streamInput インタフェース内 BytesReference
  - writeTo
```
public void writeTo(OutputStream os)
             throws IOException
```
    インタフェースからコピーされた説明: BytesReference
    
    Writes the bytes directly to the output stream.
    
    定義:
    
    writeTo インタフェース内 BytesReference
    
    例外:
    
    IOException
  - writeTo
```
public void writeTo(GatheringByteChannel channel)
             throws IOException
```
    インタフェースからコピーされた説明: BytesReference
    
    Writes the bytes directly to the channel.
    
    定義:
    
    writeTo インタフェース内 BytesReference
    
    例外:
    
    IOException
  - toBytes
```
public byte[] toBytes()
```
    インタフェースからコピーされた説明: BytesReference
    
    Returns the bytes as a single byte array.
    
    定義:
    
    toBytes インタフェース内 BytesReference
  - toBytesArray
```
public BytesArray toBytesArray()
```
    インタフェースからコピーされた説明: BytesReference
    
    Returns the bytes as a byte array, possibly sharing the underlying byte buffer.
    
    定義:
    
    toBytesArray インタフェース内 BytesReference
  - copyBytesArray
```
public BytesArray copyBytesArray()
```
    インタフェースからコピーされた説明: BytesReference
    
    Returns the bytes copied over as a byte array.
    
    定義:
    
    copyBytesArray インタフェース内 BytesReference
  - toChannelBuffer
```
public org.jboss.netty.buffer.ChannelBuffer toChannelBuffer()
```
    インタフェースからコピーされた説明: BytesReference
    
    Returns the bytes as a channel buffer.
    
    定義:
    
    toChannelBuffer インタフェース内 BytesReference
  - hasArray
```
public boolean hasArray()
```
    インタフェースからコピーされた説明: BytesReference
    
    Is there an underlying byte array for this bytes reference.
    
    定義:
    
    hasArray インタフェース内 BytesReference
  - array
```
public byte[] array()
```
    インタフェースからコピーされた説明: BytesReference
    
    The underlying byte array (if exists).
    
    定義:
    
    array インタフェース内 BytesReference
  - arrayOffset
```
public int arrayOffset()
```
    インタフェースからコピーされた説明: BytesReference
    
    The offset into the underlying byte array.
    
    定義:
    
    arrayOffset インタフェース内 BytesReference
  - toUtf8
```
public String toUtf8()
```
    インタフェースからコピーされた説明: BytesReference
    
    Converts to a string based on utf8.
    
    定義:
    
    toUtf8 インタフェース内 BytesReference
  - toBytesRef
```
public org.apache.lucene.util.BytesRef toBytesRef()
```
    インタフェースからコピーされた説明: BytesReference
    
    Converts to Lucene BytesRef.
    
    定義:
    
    toBytesRef インタフェース内 BytesReference
  - copyBytesRef
```
public org.apache.lucene.util.BytesRef copyBytesRef()
```
    インタフェースからコピーされた説明: BytesReference
    
    Converts to a copied Lucene BytesRef.
    
    定義:
    
    copyBytesRef インタフェース内 BytesReference
  - hashCode
```
public int hashCode()
```
    オーバーライド:
    
    hashCode クラス内 Object
  - equals
```
public boolean equals(Object obj)
```
    オーバーライド:
    
    equals クラス内 Object

クラス PagedBytesReference

ネストされたクラスのサマリー

インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.common.bytes.BytesReference

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

bytearray

コンストラクタの詳細

PagedBytesReference

PagedBytesReference

メソッドの詳細

get

length

slice

streamInput

writeTo

writeTo

toBytes

toBytesArray

copyBytesArray

toChannelBuffer

hasArray

array

arrayOffset

toUtf8

toBytesRef

copyBytesRef

hashCode

equals