ByteBuffer (Java Platform SE 8)

java.lang.Object
- java.nio.Buffer
- - java.nio.ByteBuffer

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

Comparable<ByteBuffer>

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

MappedByteBuffer
```
public abstract class ByteBuffer
extends Buffer
implements Comparable<ByteBuffer>
```
byteバッファです。
このクラスは、byteバッファに対する操作を次の6つのカテゴリに分類します。
- 単一byte値の読み込みと書込みを行う絶対および相対get/putメソッド。
- 連続したbyteシーケンスをこのバッファから配列へと転送する相対一括getメソッド。
- 連続したbyteシーケンスをbyte配列やその他のbyteバッファからこのバッファへと転送する相対一括putメソッド。
- その他のプリミティブ型の値の読み込みと書込みを行い、これらの値とbyteシーケンスを特定のbyte順序で相互変換する、絶対および相対get/putメソッド。
- その他のプリミティブ型の値を格納するバッファとしてbyteバッファを表示できる、「ビュー・バッファ」の作成メソッド
- byteバッファの圧縮、複製およびスライス用メソッド。
byteバッファを作成するには、バッファの内容に容量を割り当てる割り当て,を実行するか、既存のbyte配列をバッファ内にラップします。
ダイレクト・バッファと非ダイレクト・バッファ

byteバッファには、「ダイレクト」バッファと「非ダイレクト」バッファがあります。ダイレクトbyteバッファの場合、Java仮想マシンは、ネイティブの入出力操作を直接実行しようとします。これは、基本となるオペレーティング・システム固有の入出力操作を呼び出す際、中間バッファを介さないということです。
ダイレクトbyteバッファは、このクラスのファクトリ・メソッドallocateDirectを呼び出すと作成されます。通常は、こちらのバッファのほうが、非ダイレクト・バッファよりも割当ておよび解放コストがやや高くなります。ダイレクト・バッファの内容が標準のガベージ・コレクトされたヒープの外部にあるなら、アプリケーションのメモリー・フットプリントに対する影響はわずかです。このことから、ダイレクト・バッファには、基本となるシステム固有の入出力操作に従属する、寿命が長く容量の大きいバッファを指定することをお薦めします。一般に、ダイレクト・バッファの割当ては、プログラムの性能を十分に改善できる見込みがある場合にのみ行うべきです。
ダイレクトbyteバッファは、ファイルの特定の領域をメモリーに直接マッピングする方法でも作成できます。Javaプラットフォームの実装によっては、JNIを介してネイティブ・コードからダイレクトbyteバッファを生成する機能がオプションでサポートされている可能性があります。こうした種類のバッファのインスタンスが、メモリー内のアクセスできない領域を参照した場合、その領域にアクセスしようとしてもバッファの内容は変更されず、アクセス時またはアクセス後に何らかの例外がスローされます。
特定のbyteバッファがダイレクト・バッファ、非ダイレクト・バッファのどちらであるかを判断するには、isDirectメソッドを呼び出します。このメソッドを使用すると、性能が重視されるコード内で明示的にバッファ管理を行えます。
バイナリ・データへのアクセス

このクラスには、その他のすべてのプリミティブ型(booleanを除く)の値の読み込みと書込みを行うメソッドが定義されています。プリミティブ値とbyteシーケンスとの相互変換は、バッファの現在のbyte順序に従って行われます。byte順序を取得および変更するには、orderメソッドを使用します。特定のbyte順序は、ByteOrderクラスのインスタンスで表されます。byteバッファの初期順序は、常にBIG_ENDIANです。
異種バイナリ・データ、すなわち型の異なる値のシーケンスにアクセスできるようにするため、このクラスは、型ごとに一連の絶対および相対get/putメソッドのファミリを定義します。たとえば、32ビットの浮動小数点数(float値)の場合、次のメソッドが定義されます。
```
 float  getFloat()
 float  getFloat(int index)
  void  putFloat(float f)
  void  putFloat(int index, float f)
```
char、short、int、long、およびdoubleの各型にも、同様のメソッドが定義されています。絶対get/putメソッドのインデックス・パラメータの単位は、読み込みまたは書込みの対象となる型ではなく、byteです。
同種のバイナリ・データ、すなわち同じ型の値のシーケンスにアクセスできるようにするため、このクラスには、指定されたbyteバッファの「ビュー」を作成できるメソッドが定義されています。「ビュー・バッファ」とは、byteバッファに連動した内容を持つ、別のバッファのことです。byteバッファの内容に変更を加えると、ビュー・バッファにもその内容が反映されます。反対に、ビュー・バッファの内容に変更を加えると、byteバッファにもその内容が反映されます。この2つのバッファの位置、リミット、マークの値は、それぞれ独立しています。たとえば、asFloatBufferメソッドは、このメソッドの呼出し元のbyteバッファに連動したFloatBufferクラスのインスタンスを作成します。char、short、int、long、およびdoubleの各型にも、同様のビュー作成メソッドが定義されています。
ビュー・バッファには、前述した一連の型固有のget/putメソッドに勝る重要な利点が3つあります。
- ビュー・バッファには、byteではなく、その値の型固有のサイズによってインデックスが付けられる
- ビュー・バッファは、バッファと配列または同じ型のその他のバッファ間で連続した値のシーケンスをやりとりできる、相対一括get/putメソッドを提供する
- ビュー・バッファは、補助byteバッファがダイレクト・バッファである場合にかぎりダイレクト・バッファになるという点で、潜在的に効率がよい
ビュー・バッファのbyte順序は、ビューの生成時にbyteバッファと同じものに固定されます。

呼出しの連鎖

このクラスのメソッドのうち戻り値を返さないものは、自身を呼び出したバッファの情報を返します。これを応用して、メソッド呼出しを連鎖させることができます。たとえば、次のような連続した文があるとしましょう。
```
 bb.putInt(0xCAFEBABE);
 bb.putShort(3);
 bb.putShort(45);
```
これらは、次の一文で置き換えられます。
```
 bb.putInt(0xCAFEBABE).putShort(3).putShort(45);
```
導入されたバージョン:

1.4

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`static ByteBuffer`	`allocate(int capacity)` 新しいbyteバッファを割り当てます。
`static ByteBuffer`	`allocateDirect(int capacity)` 新しいダイレクトbyteバッファを割り当てます。
`byte[]`	`array()` このバッファを補助するbyte配列を返します (オプションの操作)。
`int`	`arrayOffset()` このバッファの補助配列内にある、このバッファの最初の要素のオフセットを返します (オプションの操作)。
`abstract CharBuffer`	`asCharBuffer()` charバッファとしてこのbyteバッファのビューを作成します。
`abstract DoubleBuffer`	`asDoubleBuffer()` doubleバッファとしてこのbyteバッファのビューを作成します。
`abstract FloatBuffer`	`asFloatBuffer()` floatバッファとしてこのbyteバッファのビューを作成します。
`abstract IntBuffer`	`asIntBuffer()` intバッファとしてこのbyteバッファのビューを作成します。
`abstract LongBuffer`	`asLongBuffer()` longバッファとしてこのbyteバッファのビューを作成します。
`abstract ByteBuffer`	`asReadOnlyBuffer()` このバッファの内容を共有する新しい読込み専用byteバッファを作成します。
`abstract ShortBuffer`	`asShortBuffer()` shortバッファとしてこのbyteバッファのビューを作成します。
`abstract ByteBuffer`	`compact()` このバッファを圧縮します (オプションの操作)。
`int`	`compareTo(ByteBuffer that)` このバッファを別のバッファと比較します。
`abstract ByteBuffer`	`duplicate()` このバッファの内容を共有する新しいbyteバッファを作成します。
`boolean`	`equals(Object ob)` このバッファが別のオブジェクトと等価であるかどうかを判断します。
`abstract byte`	`get()` 相対getメソッドです。
`ByteBuffer`	`get(byte[] dst)` 相対一括getメソッドです。
`ByteBuffer`	`get(byte[] dst, int offset, int length)` 相対一括getメソッドです。
`abstract byte`	`get(int index)` 絶対getメソッドです。
`abstract char`	`getChar()` char値を読み取る相対getメソッドです。
`abstract char`	`getChar(int index)` char値を読み取る絶対getメソッドです。
`abstract double`	`getDouble()` double値を読み取る相対getメソッドです。
`abstract double`	`getDouble(int index)` double値を読み取る絶対getメソッドです。
`abstract float`	`getFloat()` float値を読み取る相対getメソッドです。
`abstract float`	`getFloat(int index)` float値を読み取る絶対getメソッドです。
`abstract int`	`getInt()` int値を読み取る相対getメソッドです。
`abstract int`	`getInt(int index)` int値を読み取る絶対getメソッドです。
`abstract long`	`getLong()` long値を読み取る相対getメソッドです。
`abstract long`	`getLong(int index)` long値を読み取る絶対getメソッドです。
`abstract short`	`getShort()` short値を読み取る相対getメソッドです。
`abstract short`	`getShort(int index)` short値を読み取る絶対getメソッドです。
`boolean`	`hasArray()` このバッファがアクセス可能なbyte配列に連動するかどうかを判断します。
`int`	`hashCode()` このバッファの現在のハッシュ・コードを返します。
`abstract boolean`	`isDirect()` このbyteバッファがダイレクト・バッファであるかどうかを判断します。
`ByteOrder`	`order()` このバッファのbyte順序を取得します。
`ByteBuffer`	`order(ByteOrder bo)` このバッファのbyte順序を変更します。
`abstract ByteBuffer`	`put(byte b)` 相対putメソッドです (オプションの操作)。
`ByteBuffer`	`put(byte[] src)` 相対一括putメソッドです (オプションの操作)。
`ByteBuffer`	`put(byte[] src, int offset, int length)` 相対一括putメソッドです (オプションの操作)。
`ByteBuffer`	`put(ByteBuffer src)` 相対一括putメソッドです (オプションの操作)。
`abstract ByteBuffer`	`put(int index, byte b)` 絶対putメソッドです (オプションの操作)。
`abstract ByteBuffer`	`putChar(char value)` char値を書き込む相対putメソッドです (オプションの操作)。
`abstract ByteBuffer`	`putChar(int index, char value)` char値を書き込む絶対putメソッドです (オプションの操作)。
`abstract ByteBuffer`	`putDouble(double value)` double値を書き込む相対putメソッドです (オプションの操作)。
`abstract ByteBuffer`	`putDouble(int index, double value)` double値を書き込む絶対putメソッドです (オプションの操作)。
`abstract ByteBuffer`	`putFloat(float value)` float値を書き込む相対putメソッドです (オプションの操作)。
`abstract ByteBuffer`	`putFloat(int index, float value)` float値を書き込む絶対putメソッドです (オプションの操作)。
`abstract ByteBuffer`	`putInt(int value)` int値を書き込む相対putメソッドです (オプションの操作)。
`abstract ByteBuffer`	`putInt(int index, int value)` int値を書き込む絶対putメソッドです (オプションの操作)。
`abstract ByteBuffer`	`putLong(int index, long value)` long値を書き込む絶対putメソッドです (オプションの操作)。
`abstract ByteBuffer`	`putLong(long value)` long値を書き込む相対putメソッドです (オプションの操作)。
`abstract ByteBuffer`	`putShort(int index, short value)` short値を書き込む絶対putメソッドです (オプションの操作)。
`abstract ByteBuffer`	`putShort(short value)` short値を書き込む相対putメソッドです (オプションの操作)。
`abstract ByteBuffer`	`slice()` このバッファの共有のサブシーケンスを内容とする新しいbyteバッファを作成します。
`String`	`toString()` このバッファの状態を要約した文字列を返します。
`static ByteBuffer`	`wrap(byte[] array)` byte配列をバッファにラップします。
`static ByteBuffer`	`wrap(byte[] array, int offset, int length)` byte配列をバッファにラップします。

クラス java.nio.Bufferから継承されるメソッド
capacity, clear, flip, hasRemaining, isReadOnly, limit, limit, mark, position, position, remaining, reset, rewind

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

- メソッドの詳細
  - allocateDirect
```
public static ByteBuffer allocateDirect(int capacity)
```
    新しいダイレクトbyteバッファを割り当てます。
    新しいバッファの位置はゼロ、リミットは容量と同じ値になり、マークは定義されず、各要素はゼロに初期化されます。補助配列を利用するかどうかは指定されません。
    
    パラメータ:
    
    capacity - 新しいバッファの容量(byte)
    
    戻り値:
    
    新しいbyteバッファ
    
    例外:
    
    IllegalArgumentException - capacityが負の整数である場合
  - allocate
```
public static ByteBuffer allocate(int capacity)
```
    新しいbyteバッファを割り当てます。
    新しいバッファの位置はゼロ、リミットは容量と同じ値になり、マークは定義されず、各要素はゼロに初期化されます。補助配列を持ち、配列オフセットはゼロになります。
    
    パラメータ:
    
    capacity - 新しいバッファの容量(byte)
    
    戻り値:
    
    新しいbyteバッファ
    
    例外:
    
    IllegalArgumentException - capacityが負の整数である場合
  - wrap
```
public static ByteBuffer wrap(byte[] array,
                              int offset,
                              int length)
```
    byte配列をバッファにラップします。
    新しいバッファは指定されたbyte配列によって補助されます。バッファに変更を加えると配列も変更され、配列に変更を加えるとバッファも変更されます。新しいバッファの容量はarray.length、位置はoffset、リミットはoffset+lengthになり、マークは定義されません。指定された配列が補助配列となり、その配列オフセットはゼロになります。
    
    パラメータ:
    
    array - 新しいバッファを補助する配列
    
    offset -使用するサブ配列のオフセット。array.length以下の負でない値でなければならない。新しいバッファの位置は、この値に設定される。
    
    length - 使用するサブ配列の長さ。array.length - offset以下の負でない値でなければならない。新しいバッファのリミットは、offset+lengthに設定される。
    
    戻り値:
    
    新しいbyteバッファ
    
    例外:
    
    IndexOutOfBoundsException - offsetパラメータとlengthパラメータの前提条件が満たされていない場合
  - wrap
```
public static ByteBuffer wrap(byte[] array)
```
    byte配列をバッファにラップします。
    新しいバッファは指定されたbyte配列によって補助されます。バッファに変更を加えると配列も変更され、配列に変更を加えるとバッファも変更されます。新しいバッファの容量とリミットはarray.length、位置はゼロになり、マークは定義されません。指定された配列が補助配列となり、その配列オフセットはゼロになります。
    
    パラメータ:
    
    array - このバッファを補助する配列
    
    戻り値:
    
    新しいbyteバッファ
  - slice
```
public abstract ByteBuffer slice()
```
    このバッファの共有のサブシーケンスを内容とする新しいbyteバッファを作成します。
    新しいバッファの内容は、このバッファの現在位置から始まります。このバッファの内容に変更を加えると、その内容が新しいバッファに反映されます。新しいバッファの内容に変更を加えると、その内容がこのバッファに反映されます。2つのバッファの位置、リミット、マークの値はそれぞれ異なります。
    新しいバッファの位置はゼロ、容量とリミットはこのバッファ内に残っているbyte数になります。マークは定義されません。新しいバッファは、このバッファがダイレクト・バッファである場合にかぎりダイレクト・バッファになります。また、このバッファが読取り専用バッファである場合にかぎり読取り専用バッファになります。
    
    戻り値:
    
    新しいbyteバッファ
  - duplicate
```
public abstract ByteBuffer duplicate()
```
    このバッファの内容を共有する新しいbyteバッファを作成します。
    新しいバッファの内容は、このバッファの内容と同じになります。このバッファの内容に変更を加えると、その内容が新しいバッファに反映されます。新しいバッファの内容に変更を加えると、その内容がこのバッファに反映されます。2つのバッファの位置、リミット、マークの値はそれぞれ異なります。
    新しいバッファの容量、リミット、位置、マークの値は、このバッファの対応する値と同じになります。新しいバッファは、このバッファがダイレクト・バッファである場合にかぎりダイレクト・バッファになります。また、このバッファが読取り専用バッファである場合にかぎり読取り専用バッファになります。
    
    戻り値:
    
    新しいbyteバッファ
  - asReadOnlyBuffer
```
public abstract ByteBuffer asReadOnlyBuffer()
```
    このバッファの内容を共有する新しい読込み専用byteバッファを作成します。
    新しいバッファの内容は、このバッファの内容と同じになります。このバッファの内容に変更を加えると、その内容が新しいバッファに反映されます。しかし、新しいバッファ自体は読取り専用であり、その共有内容を変更することはできません。2つのバッファの位置、リミット、マークの値はそれぞれ異なります。
    新しいバッファの容量、リミット、位置、マークの値は、このバッファの対応する値と同じになります。
    このバッファ自身が読込み専用の場合は、このメソッドはduplicateと同じように動作します。
    
    戻り値:
    
    新しい読込み専用byteバッファ
  - get
```
public abstract byte get()
```
    相対getメソッドです。このバッファの現在位置からbyteを読み込み、現在位置の値を増加します。
    
    戻り値:
    
    バッファの現在位置のbyte
    
    例外:
    
    BufferUnderflowException - バッファの現在位置がリミット以上である場合
  - put
```
public abstract ByteBuffer put(byte b)
```
    相対putメソッドです (オプションの操作)。
    バッファの現在位置に指定されたbyteを書き込み、現在位置の値を増加します。
    
    パラメータ:
    
    b - 書き込まれるbyte
    
    戻り値:
    
    このバッファ
    
    例外:
    
    BufferOverflowException - このバッファの現在位置がリミット以上である場合
    
    ReadOnlyBufferException - このバッファが読込み専用である場合
  - get
```
public abstract byte get(int index)
```
    絶対getメソッドです。指定されたインデックス位置のbyteを読み込みます。
    
    パラメータ:
    
    index - byteの読込み位置を示すインデックス
    
    戻り値:
    
    指定されたインデックス位置のbyte
    
    例外:
    
    IndexOutOfBoundsException - indexが負の数である場合、またはバッファのリミット以上である場合
  - put
```
public abstract ByteBuffer put(int index,
                               byte b)
```
    絶対putメソッドです (オプションの操作)。
    このバッファの指定されたインデックス位置に指定されたbyteを書き込みます。
    
    パラメータ:
    
    index - byteの書込み先を示すインデックス
    
    b - 書き込まれるbyte値
    
    戻り値:
    
    このバッファ
    
    例外:
    
    IndexOutOfBoundsException - indexが負の数である場合、またはバッファのリミット以上である場合
    
    ReadOnlyBufferException - このバッファが読込み専用である場合
  - get
```
public ByteBuffer get(byte[] dst,
                      int offset,
                      int length)
```
    相対一括getメソッドです。
    このメソッドは、このバッファから指定された配列へbyteを転送します。このバッファ内に残っているbyte数が要求に満たない場合(つまり、length > remaining()である場合)、byteは一切転送されず、BufferUnderflowExceptionがスローされます。
    それ以外の場合、このメソッドは、length個のbyteを、このバッファの現在位置から指定された配列の指定されたオフセット位置へコピーします。そのたびに、このバッファの位置がlengthずつ増加します。
    このメソッドをsrc.get(dst, off, len)の形式で呼び出すと、次のループとまったく同じ結果になります。
```
     for (int i = off; i < off + len; i++)
         dst[i] = src.get():
 
```
    ただし、このバッファ内に十分な数のbyte数があることを最初に確認する動作は除きます。また、このメソッドを使用したほうがループよりもはるかに効率的です。
    パラメータ:
    
    dst - byteの書込み先となる配列
    
    offset - 最初のbyteの書込み先となる配列内のオフセット。dst.length以下の負でない値でなければならない
    
    length - 指定された配列に書き込まれる最大byte数。dst.length - offset以下の負でない値でなければならない
    
    戻り値:
    
    このバッファ
    
    例外:
    
    BufferUnderflowException - このバッファ内に残っているbyte数がlengthよりも少ない場合
    
    IndexOutOfBoundsException - offsetパラメータとlengthパラメータの前提条件が満たされていない場合
  - get
```
public ByteBuffer get(byte[] dst)
```
    相対一括getメソッドです。
    このメソッドは、このバッファから指定された配列へbyteを転送します。このメソッドをsrc.get(a)の形式で呼び出すと、次の呼び出しと同じ結果になります。
```
     src.get(a, 0, a.length) 
```
    パラメータ:
    
    dst - コピー先配列
    
    戻り値:
    
    このバッファ
    
    例外:
    
    BufferUnderflowException - このバッファ内に残っているbyte数がlengthよりも少ない場合
  - put
```
public ByteBuffer put(ByteBuffer src)
```
    相対一括putメソッドです (オプションの操作)。
    このメソッドは、指定されたソース・バッファ内に残っているbyteをこのバッファへ転送します。ソース・バッファ内に残っているbyte数がこのバッファ内に残っているbyte数よりも多い場合(つまり、src.remaining() > remaining()である場合)、byteは一切転送されず、BufferOverflowExceptionがスローされます。
    それ以外の場合、このメソッドは、指定されたバッファの現在位置からこのバッファの現在位置へn = src.remaining() byteをコピーします。そのたびに、両方のバッファの位置がnずつ増加します。
    このメソッドをdst.put(src)の形式で呼び出すと、次のループとまったく同じ結果になります。
```
     while (src.hasRemaining())
         dst.put(src.get()); 
```
    ただし、このバッファ内に十分な容量があることを最初に確認する動作は除きます。また、このメソッドを使用したほうがループよりもはるかに効率的です。
    パラメータ:
    
    src - byteの読込み先となるソース・バッファ(このバッファ以外)
    
    戻り値:
    
    このバッファ
    
    例外:
    
    BufferOverflowException - このバッファに、ソース・バッファ内に残っているbyteを格納できるだけの容量がない場合
    
    IllegalArgumentException - ソース・バッファとしてこのバッファを指定した場合
    
    ReadOnlyBufferException - このバッファが読込み専用である場合
  - put
```
public ByteBuffer put(byte[] src,
                      int offset,
                      int length)
```
    相対一括putメソッドです (オプションの操作)。
    このメソッドは、指定されたソース配列からこのバッファへbyteを転送します。配列からコピーするbyte数がこのバッファ内に残っているbyte数より多い場合(つまり、length > remaining()である場合)、byteは一切転送されず、BufferOverflowExceptionがスローされます。
    それ以外の場合、このメソッドは、指定された配列の指定されたオフセット位置からこのバッファの現在位置へlength個のbyteをコピーします。そのたびに、このバッファの位置がlengthずつ増加します。
    このメソッドをdst.put(src, off, len)の形式で呼び出すと、次のループとまったく同じ結果になります。
```
     for (int i = off; i < off + len; i++)
         dst.put(a[i]);
 
```
    ただし、このバッファ内に十分な容量があることを最初に確認する動作は除きます。また、このメソッドを使用したほうがループよりもはるかに効率的です。
    パラメータ:
    
    src - byteの読込み先となる配列
    
    offset - 最初のbyteの読込み先となる配列内のオフセット。array.length以下の負でない値にする必要がある
    
    length - 指定された配列から読み取られるbyte数。array.length - offset以下の負でない値でなければならない
    
    戻り値:
    
    このバッファ
    
    例外:
    
    BufferOverflowException - このバッファ内に残っている容量が不足している場合
    
    IndexOutOfBoundsException - offsetパラメータとlengthパラメータの前提条件が満たされていない場合
    
    ReadOnlyBufferException - このバッファが読込み専用である場合
  - put
```
public final ByteBuffer put(byte[] src)
```
    相対一括putメソッドです (オプションの操作)。
    このメソッドは、ソースとなる指定されたbyte配列の内容全体をこのバッファへ転送します。このメソッドをdst.put(a)の形式で呼び出すと、次の呼び出しと同じ結果になります。
```
     dst.put(a, 0, a.length) 
```
    パラメータ:
    
    src - 転送元配列
    
    戻り値:
    
    このバッファ
    
    例外:
    
    BufferOverflowException - このバッファ内に残っている容量が不足している場合
    
    ReadOnlyBufferException - このバッファが読込み専用である場合
  - hasArray
```
public final boolean hasArray()
```
    このバッファがアクセス可能なbyte配列に連動するかどうかを判断します。
    このメソッドの戻り値がtrueであれば、arrayおよびarrayOffsetメソッドを安全に呼び出すことができます。
    
    定義:
    
    hasArray、クラス: Buffer
    
    戻り値:
    
    このバッファが配列に連動しており、読取り専用でない場合にかぎりtrue
  - array
```
public final byte[] array()
```
    このバッファを補助するbyte配列を返します (オプションの操作)。
    このバッファの内容に変更を加えると、返される配列の内容も変更されます。その逆も同様です。
    このメソッドを呼び出す前にhasArrayメソッドを呼び出し、このバッファがアクセス可能な補助配列を持っていることを確認します。
    
    定義:
    
    array、クラス: Buffer
    
    戻り値:
    
    このバッファを補助する配列
    
    例外:
    
    ReadOnlyBufferException - このバッファが配列に連動しており、しかも読込み専用である場合
    
    UnsupportedOperationException - このバッファがアクセス可能な配列を利用しない場合
  - arrayOffset
```
public final int arrayOffset()
```
    このバッファの補助配列内にある、このバッファの最初の要素のオフセットを返します (オプションの操作)。
    このバッファが配列に連動していれば、その位置pが配列のインデックスp + arrayOffset()と一致します。
    このメソッドを呼び出す前にhasArrayメソッドを呼び出し、このバッファがアクセス可能な補助配列を持っていることを確認します。
    
    定義:
    
    arrayOffset、クラス: Buffer
    
    戻り値:
    
    このバッファの配列内にある、このバッファの最初の要素のオフセット
    
    例外:
    
    ReadOnlyBufferException - このバッファが配列に連動しており、しかも読込み専用である場合
    
    UnsupportedOperationException - このバッファがアクセス可能な配列を利用しない場合
  - compact
```
public abstract ByteBuffer compact()
```
    このバッファを圧縮します (オプションの操作)。
    バッファの現在位置からリミットまでの間にbyteが存在する場合、これらをバッファの先頭にコピーします。つまり、インデックス位置p = position()のbyteがインデックス・ゼロにコピーされ、インデックス位置p + 1のbyteがインデックス1にコピーされるということです。インデックス位置limit() - 1のbyteがインデックスn = limit() - 1 - pにコピーされるまで、同様の処理が繰り返されます。最終的にバッファの位置はn+1に設定され、リミットは容量の値と等しくなります。マークは破棄されます。
    バッファの位置は、ゼロではなく、コピーされるbyte数と等しくなります。したがって、このメソッドを呼び出したあと、すぐに別の相対「put」メソッドを呼び出すことができます。
    
    このメソッドは、書込みが終了しなかった場合にバッファからのデータの書込みを実行する前に呼び出します。次のループは、バッファbufを使って、あるチャネルから別のチャネルにbyteをコピーします。
    buf.clear(); // Prepare buffer for use while (in.read(buf) >= 0 || buf.position != 0) { buf.flip(); out.write(buf); buf.compact(); // In case of partial write }
    戻り値:
    
    このバッファ
    
    例外:
    
    ReadOnlyBufferException - このバッファが読込み専用である場合
  - isDirect
```
public abstract boolean isDirect()
```
    このbyteバッファがダイレクト・バッファであるかどうかを判断します。
    
    定義:
    
    isDirect、クラス: Buffer
    
    戻り値:
    
    このバッファがダイレクト・バッファである場合にかぎりtrue
  - toString
```
public String toString()
```
    このバッファの状態を要約した文字列を返します。
    
    オーバーライド:
    
    toString、クラス: Object
    
    戻り値:
    
    サマリー文字列
  - hashCode
```
public int hashCode()
```
    このバッファの現在のハッシュ・コードを返します。
    byteバッファのハッシュ・コードは、バッファ内に残っている要素、すなわちposition()からlimit() - 1までの要素のみに依存します。
    バッファのハッシュ・コードは内容依存型です。今後バッファの内容が変更されないことが明らかでないかぎり、バッファをハッシュ・マップその他のデータ構造のキーとして使用することは避けてください。
    
    オーバーライド:
    
    hashCode、クラス: Object
    
    戻り値:
    
    このバッファの現在のハッシュ・コード
    
    関連項目:
    
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - equals
```
public boolean equals(Object ob)
```
    このバッファが別のオブジェクトと等価であるかどうかを判断します。
    2つのbyteバッファは、次の場合にかぎり等価です。
    1. 要素の型が同じである
    2. バッファ内に残っている要素数が同じである
    3. バッファ内に残っている要素のシーケンス(開始位置とは無関係)が各点で等しい(pointwise equal)
    byteバッファが、その他の型のオブジェクトと等価になることはありません。
    オーバーライド:
    
    equals、クラス: Object
    
    パラメータ:
    
    ob - このバッファと比較するオブジェクト
    
    戻り値:
    
    このバッファが指定されたオブジェクトと等価である場合にかぎりtrue
    
    関連項目:
    
    Object.hashCode()、HashMap
  - compareTo
```
public int compareTo(ByteBuffer that)
```
    このバッファを別のバッファと比較します。
    2つのbyteバッファを比較する際は、バッファ内に残っている要素のシーケンスが辞書順に比較されます。このとき、双方のバッファ内に残っているシーケンスの開始位置は考慮されません。Byte.compare(byte,byte)を呼び出したかのように、byte要素のペアが比較されます。
    byteバッファとその他の型のオブジェクトを比較することはできません。
    
    定義:
    
    compareTo、インタフェース: Comparable<ByteBuffer>
    
    パラメータ:
    
    that - 比較対象のオブジェクト。
    
    戻り値:
    
    このバッファが指定されたバッファより小さい場合は負の整数、等しい場合はゼロ、大きい場合は正の整数
  - order
```
public final ByteOrder order()
```
    このバッファのbyte順序を取得します。
    byte順序は、複数バイトの値を読み取るときや書き込むとき、そしてこのbyteバッファのビューとなるバッファを作成するときに使用します。新しく作成されたbyteバッファの順序は常にBIG_ENDIANになります。
    
    戻り値:
    
    このバッファのbyte順序
  - order
```
public final ByteBuffer order(ByteOrder bo)
```
    このバッファのbyte順序を変更します。
    
    パラメータ:
    
    bo - 新しいbyte順序。BIG_ENDIANまたはLITTLE_ENDIANのいずれか
    
    戻り値:
    
    このバッファ
  - getChar
```
public abstract char getChar()
```
    char値を読み取る相対getメソッドです。
    このバッファの現在位置から2 byteを読み込み、現在のbyte順序に従って、これらをchar値に変換します。位置の値は、そのたびに2ずつ増加します。
    
    戻り値:
    
    バッファの現在位置のchar値
    
    例外:
    
    BufferUnderflowException - このバッファ内に残っているbyte数が2 byteより少ない場合
  - putChar
```
public abstract ByteBuffer putChar(char value)
```
    char値を書き込む相対putメソッドです (オプションの操作)。
    このバッファの現在位置に、現在のbyte順序に従って、指定されたchar値を含む2 byteを書き込みます。位置の値は、そのたびに2ずつ増加します。
    
    パラメータ:
    
    value - 書き込まれるchar値
    
    戻り値:
    
    このバッファ
    
    例外:
    
    BufferOverflowException - このバッファ内に残っているbyte数が2 byteより少ない場合
    
    ReadOnlyBufferException - このバッファが読込み専用である場合
  - getChar
```
public abstract char getChar(int index)
```
    char値を読み取る絶対getメソッドです。
    指定されたインデックス位置にある2 byteを読み込み、現在のbyte順序に従って、これらをchar値に変換します。
    
    パラメータ:
    
    index - byteの読込み位置を示すインデックス
    
    戻り値:
    
    指定されたインデックス位置のchar値
    
    例外:
    
    IndexOutOfBoundsException - indexが負の値である場合、またはバッファのリミット以上である場合、-1
  - putChar
```
public abstract ByteBuffer putChar(int index,
                                   char value)
```
    char値を書き込む絶対putメソッドです (オプションの操作)。
    このバッファの指定されたインデックス位置に、現在のbyte順序に従って、指定されたchar値を含む2 byteを書き込みます。
    
    パラメータ:
    
    index - byteの書込み先を示すインデックス
    
    value - 書き込まれるchar値
    
    戻り値:
    
    このバッファ
    
    例外:
    
    IndexOutOfBoundsException - indexが負の値である場合、またはバッファのリミット以上である場合、-1
    
    ReadOnlyBufferException - このバッファが読込み専用である場合
  - asCharBuffer
```
public abstract CharBuffer asCharBuffer()
```
    charバッファとしてこのbyteバッファのビューを作成します。
    新しいバッファの内容は、このバッファの現在位置から始まります。このバッファの内容に変更を加えると、その内容が新しいバッファに反映されます。新しいバッファの内容に変更を加えると、その内容がこのバッファに反映されます。2つのバッファの位置、リミット、マークの値はそれぞれ異なります。
    新しいバッファの位置はゼロ、容量とリミットはこのバッファ内に残っているbyte数の1/2になります。マークは定義されません。新しいバッファは、このバッファがダイレクト・バッファである場合にかぎりダイレクト・バッファになります。また、このバッファが読取り専用バッファである場合にかぎり読取り専用バッファになります。
    
    戻り値:
    
    新しいcharバッファ
  - getShort
```
public abstract short getShort()
```
    short値を読み取る相対getメソッドです。
    このバッファの現在位置から2 byteを読み込み、現在のbyte順序に従って、これらをshort値に変換します。位置の値は、そのたびに2ずつ増加します。
    
    戻り値:
    
    バッファの現在位置のshort値
    
    例外:
    
    BufferUnderflowException - このバッファ内に残っているbyte数が2 byteより少ない場合
  - putShort
```
public abstract ByteBuffer putShort(short value)
```
    short値を書き込む相対putメソッドです (オプションの操作)。
    このバッファの現在位置に、現在のbyte順序に従って、指定されたshort値を含む2 byteを書き込みます。位置の値は、そのたびに2ずつ増加します。
    
    パラメータ:
    
    value - 書き込まれるshort値
    
    戻り値:
    
    このバッファ
    
    例外:
    
    BufferOverflowException - このバッファ内に残っているbyte数が2 byteより少ない場合
    
    ReadOnlyBufferException - このバッファが読込み専用である場合
  - getShort
```
public abstract short getShort(int index)
```
    short値を読み取る絶対getメソッドです。
    指定されたインデックス位置にある2 byteを読み込み、現在のbyte順序に従って、これらをshort値に変換します。
    
    パラメータ:
    
    index - byteの読込み位置を示すインデックス
    
    戻り値:
    
    指定されたインデックス位置のshort値
    
    例外:
    
    IndexOutOfBoundsException - indexが負の値である場合、またはバッファのリミット以上である場合、-1
  - putShort
```
public abstract ByteBuffer putShort(int index,
                                    short value)
```
    short値を書き込む絶対putメソッドです (オプションの操作)。
    このバッファの指定されたインデックス位置に、現在のbyte順序に従って、指定されたshort値を含む2 byteを書き込みます。
    
    パラメータ:
    
    index - byteの書込み先を示すインデックス
    
    value - 書き込まれるshort値
    
    戻り値:
    
    このバッファ
    
    例外:
    
    IndexOutOfBoundsException - indexが負の値である場合、またはバッファのリミット以上である場合、-1
    
    ReadOnlyBufferException - このバッファが読込み専用である場合
  - asShortBuffer
```
public abstract ShortBuffer asShortBuffer()
```
    shortバッファとしてこのbyteバッファのビューを作成します。
    新しいバッファの内容は、このバッファの現在位置から始まります。このバッファの内容に変更を加えると、その内容が新しいバッファに反映されます。新しいバッファの内容に変更を加えると、その内容がこのバッファに反映されます。2つのバッファの位置、リミット、マークの値はそれぞれ異なります。
    新しいバッファの位置はゼロ、容量とリミットはこのバッファ内に残っているbyte数の1/2になります。マークは定義されません。新しいバッファは、このバッファがダイレクト・バッファである場合にかぎりダイレクト・バッファになります。また、このバッファが読取り専用バッファである場合にかぎり読取り専用バッファになります。
    
    戻り値:
    
    新しいshortバッファ
  - getInt
```
public abstract int getInt()
```
    int値を読み取る相対getメソッドです。
    このバッファの現在位置から4 byteを読み込み、現在のbyte順序に従って、これらをint値に変換します。位置の値は、そのたびに4ずつ増加します。
    
    戻り値:
    
    バッファの現在位置のint値
    
    例外:
    
    BufferUnderflowException - このバッファ内に残っているbyte数が4 byteより少ない場合
  - putInt
```
public abstract ByteBuffer putInt(int value)
```
    int値を書き込む相対putメソッドです (オプションの操作)。
    このバッファの現在位置に、現在のbyte順序に従って、指定されたint値を含む4 byteを書き込みます。位置の値は、そのたびに4ずつ増加します。
    
    パラメータ:
    
    value - 書き込まれるint値
    
    戻り値:
    
    このバッファ
    
    例外:
    
    BufferOverflowException - このバッファ内に残っているbyte数が4 byteより少ない場合
    
    ReadOnlyBufferException - このバッファが読込み専用である場合
  - getInt
```
public abstract int getInt(int index)
```
    int値を読み取る絶対getメソッドです。
    指定されたインデックス位置にある4 byteを読み込み、現在のbyte順序に従って、これらをint値に変換します。
    
    パラメータ:
    
    index - byteの読込み位置を示すインデックス
    
    戻り値:
    
    指定されたインデックス位置のint値
    
    例外:
    
    IndexOutOfBoundsException - indexが負の値である場合、またはバッファのリミット以上である場合、-3
  - putInt
```
public abstract ByteBuffer putInt(int index,
                                  int value)
```
    int値を書き込む絶対putメソッドです (オプションの操作)。
    このバッファの指定されたインデックス位置に、現在のbyte順序に従って、指定されたint値を含む4 byteを書き込みます。
    
    パラメータ:
    
    index - byteの書込み先を示すインデックス
    
    value - 書き込まれるint値
    
    戻り値:
    
    このバッファ
    
    例外:
    
    IndexOutOfBoundsException - indexが負の値である場合、またはバッファのリミット以上である場合、-3
    
    ReadOnlyBufferException - このバッファが読込み専用である場合
  - asIntBuffer
```
public abstract IntBuffer asIntBuffer()
```
    intバッファとしてこのbyteバッファのビューを作成します。
    新しいバッファの内容は、このバッファの現在位置から始まります。このバッファの内容に変更を加えると、その内容が新しいバッファに反映されます。新しいバッファの内容に変更を加えると、その内容がこのバッファに反映されます。2つのバッファの位置、リミット、マークの値はそれぞれ異なります。
    新しいバッファの位置はゼロ、容量とリミットはこのバッファ内に残っているbyte数の1/4になります。マークは定義されません。新しいバッファは、このバッファがダイレクト・バッファである場合にかぎりダイレクト・バッファになります。また、このバッファが読取り専用バッファである場合にかぎり読取り専用バッファになります。
    
    戻り値:
    
    新しいintバッファ
  - getLong
```
public abstract long getLong()
```
    long値を読み取る相対getメソッドです。
    このバッファの現在位置から8 byteを読み込み、現在のbyte順序に従って、これらをlong値に変換します。位置の値は、そのたびに8ずつ増加します。
    
    戻り値:
    
    バッファの現在位置のlong値
    
    例外:
    
    BufferUnderflowException - このバッファ内に残っているbyte数が8 byteより少ない場合
  - putLong
```
public abstract ByteBuffer putLong(long value)
```
    long値を書き込む相対putメソッドです (オプションの操作)。
    このバッファの現在位置に、現在のbyte順序に従って、指定されたlong値を含む8 byteを書き込みます。位置の値は、そのたびに8ずつ増加します。
    
    パラメータ:
    
    value - 書き込まれるlong値
    
    戻り値:
    
    このバッファ
    
    例外:
    
    BufferOverflowException - このバッファ内に残っているbyte数が8 byteより少ない場合
    
    ReadOnlyBufferException - このバッファが読込み専用である場合
  - getLong
```
public abstract long getLong(int index)
```
    long値を読み取る絶対getメソッドです。
    指定されたインデックス位置にある8 byteを読み込み、現在のbyte順序に従って、これらをlong値に変換します。
    
    パラメータ:
    
    index - byteの読込み位置を示すインデックス
    
    戻り値:
    
    指定されたインデックス位置のlong値
    
    例外:
    
    IndexOutOfBoundsException - indexが負の値である場合、またはバッファのリミット以上である場合、-7
  - putLong
```
public abstract ByteBuffer putLong(int index,
                                   long value)
```
    long値を書き込む絶対putメソッドです (オプションの操作)。
    このバッファの指定されたインデックス位置に、現在のbyte順序に従って、指定されたlong値を含む8 byteを書き込みます。
    
    パラメータ:
    
    index - byteの書込み先を示すインデックス
    
    value - 書き込まれるlong値
    
    戻り値:
    
    このバッファ
    
    例外:
    
    IndexOutOfBoundsException - indexが負の値である場合、またはバッファのリミット以上である場合、-7
    
    ReadOnlyBufferException - このバッファが読込み専用である場合
  - asLongBuffer
```
public abstract LongBuffer asLongBuffer()
```
    longバッファとしてこのbyteバッファのビューを作成します。
    新しいバッファの内容は、このバッファの現在位置から始まります。このバッファの内容に変更を加えると、その内容が新しいバッファに反映されます。新しいバッファの内容に変更を加えると、その内容がこのバッファに反映されます。2つのバッファの位置、リミット、マークの値はそれぞれ異なります。
    新しいバッファの位置はゼロ、容量とリミットはこのバッファ内に残っているbyte数の1/8になります。マークは定義されません。新しいバッファは、このバッファがダイレクト・バッファである場合にかぎりダイレクト・バッファになります。また、このバッファが読取り専用バッファである場合にかぎり読取り専用バッファになります。
    
    戻り値:
    
    新しいlongバッファ
  - getFloat
```
public abstract float getFloat()
```
    float値を読み取る相対getメソッドです。
    このバッファの現在位置から4 byteを読み込み、現在のbyte順序に従って、これらをfloat値に変換します。位置の値は、そのたびに4ずつ増加します。
    
    戻り値:
    
    バッファの現在位置のfloat値
    
    例外:
    
    BufferUnderflowException - このバッファ内に残っているbyte数が4 byteより少ない場合
  - putFloat
```
public abstract ByteBuffer putFloat(float value)
```
    float値を書き込む相対putメソッドです (オプションの操作)。
    このバッファの現在位置に、現在のbyte順序に従って、指定されたfloat値を含む4 byteを書き込みます。位置の値は、そのたびに4ずつ増加します。
    
    パラメータ:
    
    value - 書き込まれるfloat値
    
    戻り値:
    
    このバッファ
    
    例外:
    
    BufferOverflowException - このバッファ内に残っているbyte数が4 byteより少ない場合
    
    ReadOnlyBufferException - このバッファが読込み専用である場合
  - getFloat
```
public abstract float getFloat(int index)
```
    float値を読み取る絶対getメソッドです。
    指定されたインデックス位置にある4 byteを読み込み、現在のbyte順序に従って、これらをfloat値に変換します。
    
    パラメータ:
    
    index - byteの読込み位置を示すインデックス
    
    戻り値:
    
    指定されたインデックス位置のfloat値
    
    例外:
    
    IndexOutOfBoundsException - indexが負の値である場合、またはバッファのリミット以上である場合、-3
  - putFloat
```
public abstract ByteBuffer putFloat(int index,
                                    float value)
```
    float値を書き込む絶対putメソッドです (オプションの操作)。
    このバッファの指定されたインデックス位置に、現在のbyte順序に従って、指定されたfloat値を含む4 byteを書き込みます。
    
    パラメータ:
    
    index - byteの書込み先を示すインデックス
    
    value - 書き込まれるfloat値
    
    戻り値:
    
    このバッファ
    
    例外:
    
    IndexOutOfBoundsException - indexが負の値である場合、またはバッファのリミット以上である場合、-3
    
    ReadOnlyBufferException - このバッファが読込み専用である場合
  - asFloatBuffer
```
public abstract FloatBuffer asFloatBuffer()
```
    floatバッファとしてこのbyteバッファのビューを作成します。
    新しいバッファの内容は、このバッファの現在位置から始まります。このバッファの内容に変更を加えると、その内容が新しいバッファに反映されます。新しいバッファの内容に変更を加えると、その内容がこのバッファに反映されます。2つのバッファの位置、リミット、マークの値はそれぞれ異なります。
    新しいバッファの位置はゼロ、容量とリミットはこのバッファ内に残っているbyte数の1/4になります。マークは定義されません。新しいバッファは、このバッファがダイレクト・バッファである場合にかぎりダイレクト・バッファになります。また、このバッファが読取り専用バッファである場合にかぎり読取り専用バッファになります。
    
    戻り値:
    
    新しいfloatバッファ
  - getDouble
```
public abstract double getDouble()
```
    double値を読み取る相対getメソッドです。
    このバッファの現在位置から8 byteを読み込み、現在のbyte順序に従って、これらをdouble値に変換します。位置の値は、そのたびに8ずつ増加します。
    
    戻り値:
    
    バッファの現在位置のdouble値
    
    例外:
    
    BufferUnderflowException - このバッファ内に残っているbyte数が8 byteより少ない場合
  - putDouble
```
public abstract ByteBuffer putDouble(double value)
```
    double値を書き込む相対putメソッドです (オプションの操作)。
    このバッファの現在位置に、現在のbyte順序に従って、指定されたdouble値を含む8 byteを書き込みます。位置の値は、そのたびに8ずつ増加します。
    
    パラメータ:
    
    value - 書き込まれるdouble値
    
    戻り値:
    
    このバッファ
    
    例外:
    
    BufferOverflowException - このバッファ内に残っているbyte数が8 byteより少ない場合
    
    ReadOnlyBufferException - このバッファが読込み専用である場合
  - getDouble
```
public abstract double getDouble(int index)
```
    double値を読み取る絶対getメソッドです。
    指定されたインデックス位置にある8 byteを読み込み、現在のbyte順序に従って、これらをdouble値に変換します。
    
    パラメータ:
    
    index - byteの読込み位置を示すインデックス
    
    戻り値:
    
    指定されたインデックス位置のdouble値
    
    例外:
    
    IndexOutOfBoundsException - indexが負の値である場合、またはバッファのリミット以上である場合、-7
  - putDouble
```
public abstract ByteBuffer putDouble(int index,
                                     double value)
```
    double値を書き込む絶対putメソッドです (オプションの操作)。
    このバッファの指定されたインデックス位置に、現在のbyte順序に従って、指定されたdouble値を含む8 byteを書き込みます。
    
    パラメータ:
    
    index - byteの書込み先を示すインデックス
    
    value - 書き込まれるdouble値
    
    戻り値:
    
    このバッファ
    
    例外:
    
    IndexOutOfBoundsException - indexが負の値である場合、またはバッファのリミット以上である場合、-7
    
    ReadOnlyBufferException - このバッファが読込み専用である場合
  - asDoubleBuffer
```
public abstract DoubleBuffer asDoubleBuffer()
```
    doubleバッファとしてこのbyteバッファのビューを作成します。
    新しいバッファの内容は、このバッファの現在位置から始まります。このバッファの内容に変更を加えると、その内容が新しいバッファに反映されます。新しいバッファの内容に変更を加えると、その内容がこのバッファに反映されます。2つのバッファの位置、リミット、マークの値はそれぞれ異なります。
    新しいバッファの位置はゼロ、容量とリミットはこのバッファ内に残っているbyte数の1/8になります。マークは定義されません。新しいバッファは、このバッファがダイレクト・バッファである場合にかぎりダイレクト・バッファになります。また、このバッファが読取り専用バッファである場合にかぎり読取り専用バッファになります。
    
    戻り値:
    
    新しいdoubleバッファ

バグまたは機能を送信
詳細なAPIリファレンスおよび開発者ドキュメントについては、Java SEのドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright© 1993, 2014, Oracle and/or its affiliates. All rights reserved.

クラスByteBuffer

ダイレクト・バッファと非ダイレクト・バッファ

バイナリ・データへのアクセス

呼出しの連鎖

メソッドのサマリー

クラス java.nio.Bufferから継承されるメソッド

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

メソッドの詳細

allocateDirect

allocate

wrap

wrap

slice

duplicate

asReadOnlyBuffer

get

put

get

put

get

get

put

put

put

hasArray

array

arrayOffset

compact

isDirect

toString

hashCode

equals

compareTo

order

order

getChar

putChar

getChar

putChar

asCharBuffer

getShort

putShort

getShort

putShort

asShortBuffer

getInt

putInt

getInt

putInt

asIntBuffer

getLong

putLong

getLong

putLong

asLongBuffer

getFloat

putFloat

getFloat

putFloat

asFloatBuffer

getDouble

putDouble

getDouble

putDouble

asDoubleBuffer