Java : Buffer - API使用例
更新日：2023年08月08日 公開日：2023年08月03日
Buffer (Java SE 20 & JDK 20) の使用例まとめです。
だいたいのメソッドを網羅済みです。
API仕様のおともにどうぞ。
概要
特定のプリミティブ型データのコンテナです。
Buffer クラスは、byte や int といった プリミティブ型 のバッファです。
具体的な実装として、byte 型を扱う ByteBuffer や、int 型を扱う IntBuffer などがあります。
配列と違い、
- 容量(capacity) : バッファのサイズ。配列の length に相当
- リミット(limit) : どの位置まで読み書き可能にするか
- 位置(position) : 次に読み書きする位置
という３つのプロパティを持ちます。
final var buffer = IntBuffer.allocate(5);
System.out.println(buffer instanceof Buffer); // true
System.out.println(buffer.capacity()); // 5
System.out.println(buffer.limit()); // 5
System.out.println(buffer.position()); // 0
buffer.put(10);
System.out.println(buffer.position()); // 1
buffer.put(20);
System.out.println(buffer.position()); // 2
buffer.put(30);
System.out.println(buffer.position()); // 3
if (buffer.hasArray()) {
final var ret = buffer.array();
System.out.println(Arrays.toString(ret)); // [10, 20, 30, 0, 0]
}
final byte[] array = {10, 20, 30};
final var buffer = ByteBuffer.wrap(array);
System.out.println(buffer instanceof Buffer); // true
System.out.println(buffer.capacity()); // 3
System.out.println(buffer.limit()); // 3
System.out.println(buffer.position()); // 0
System.out.println(buffer.get()); // 10
System.out.println(buffer.position()); // 1
System.out.println(buffer.get()); // 20
System.out.println(buffer.position()); // 2
System.out.println(buffer.get()); // 30
System.out.println(buffer.position()); // 3
メソッド
abstract Object array ()
このバッファを補助する配列を返します (オプションの操作)。
final Buffer buffer = IntBuffer.allocate(5)
.put(10)
.put(20)
.put(30);
if (buffer.hasArray()) {
if (buffer.array() instanceof int[] array) {
System.out.println(Arrays.toString(array)); // [10, 20, 30, 0, 0]
}
}
abstract int arrayOffset ()
このバッファの補助配列内にある、このバッファの最初の要素のオフセットを返します (オプションの操作)。
final byte[] bytes = {10, 20, 30, 40, 50};
final var buffer = ByteBuffer.wrap(bytes);
System.out.println(buffer instanceof Buffer); // true
final var sliced = buffer.slice(2, 3);
System.out.println(sliced instanceof Buffer); // true
System.out.println(buffer); // java.nio.HeapByteBuffer[pos=0 lim=5 cap=5]
if (buffer.hasArray()) {
System.out.println(buffer.arrayOffset()); // 0
System.out.println(buffer.get()); // 10
System.out.println(buffer.get()); // 20
System.out.println(buffer.get()); // 30
System.out.println(buffer.get()); // 40
System.out.println(buffer.get()); // 50
}
System.out.println(sliced); // java.nio.HeapByteBuffer[pos=0 lim=3 cap=3]
if (sliced.hasArray()) {
System.out.println(sliced.arrayOffset()); // 2
System.out.println(sliced.get()); // 30
System.out.println(sliced.get()); // 40
System.out.println(sliced.get()); // 50
}
final int capacity ()
このバッファの容量を返します。
final Buffer buffer = ByteBuffer.allocate(100);
System.out.println(buffer.capacity()); // 100
final byte[] bytes = {10, 20, 30, 40, 50};
final Buffer buffer = ByteBuffer.wrap(bytes);
System.out.println(buffer.capacity()); // 5
Buffer clear ()
このバッファをクリアします。
関連 : rewind()
final byte[] array = {10, 20, 30, 40, 50};
final var buffer = ByteBuffer.wrap(array);
System.out.println(buffer instanceof Buffer); // true
buffer.position(2);
buffer.limit(4);
System.out.println(buffer); // java.nio.HeapByteBuffer[pos=2 lim=4 cap=5]
System.out.println(buffer.get()); // 30
System.out.println(buffer.get()); // 40
System.out.println(buffer.hasRemaining()); // false
System.out.println(buffer.clear()); // java.nio.HeapByteBuffer[pos=0 lim=5 cap=5]
System.out.println(buffer.get()); // 10
System.out.println(buffer.get()); // 20
System.out.println(buffer.get()); // 30
System.out.println(buffer.get()); // 40
System.out.println(buffer.get()); // 50
System.out.println(buffer.hasRemaining()); // false
abstract Buffer duplicate ()
このバッファの内容を共有する新しいバッファを作成します。
final byte[] array = {10, 20, 30, 40, 50};
final var buffer = ByteBuffer.wrap(array);
System.out.println(buffer instanceof Buffer); // true
buffer.position(1);
buffer.limit(4);
final var duplicated = buffer.duplicate();
System.out.println(duplicated instanceof Buffer); // true
System.out.println(buffer); // java.nio.HeapByteBuffer[pos=1 lim=4 cap=5]
System.out.println(duplicated); // java.nio.HeapByteBuffer[pos=1 lim=4 cap=5]
System.out.println(buffer.get()); // 20
System.out.println(buffer.get()); // 30
System.out.println(buffer.get()); // 40
System.out.println(duplicated.get()); // 20
System.out.println(duplicated.get()); // 30
System.out.println(duplicated.get()); // 40
Buffer flip ()
このバッファをフリップ(反転)します。
final byte[] array = {10, 20, 30, 40, 50};
final var buffer = ByteBuffer.wrap(array);
System.out.println(buffer instanceof Buffer); // true
System.out.println(buffer.get()); // 10
System.out.println(buffer.get()); // 20
System.out.println(buffer.get()); // 30
System.out.println(buffer); // java.nio.HeapByteBuffer[pos=3 lim=5 cap=5]
System.out.println(buffer.flip()); // java.nio.HeapByteBuffer[pos=0 lim=3 cap=5]
System.out.println(buffer.get()); // 10
System.out.println(buffer.get()); // 20
System.out.println(buffer.get()); // 30
abstract boolean hasArray ()
このバッファがアクセス可能な配列に連動するかどうかを判断します。
final var buffer = IntBuffer.allocate(5)
.put(10)
.put(20)
.put(30);
System.out.println(buffer instanceof Buffer); // true
final var ret = buffer.hasArray();
System.out.println(ret); // true
if (ret) {
final var array = buffer.array();
System.out.println(Arrays.toString(array)); // [10, 20, 30, 0, 0]
}
final var buffer = ByteBuffer.allocateDirect(5);
System.out.println(buffer instanceof Buffer); // true
System.out.println(buffer.hasArray()); // false
try {
final var array = buffer.array();
} catch (UnsupportedOperationException e) {
System.out.println("UnsupportedOperationException!");
}
// 結果
// ↓
//UnsupportedOperationException!
final boolean hasRemaining ()
現在位置からリミットまでに要素が1つでも存在するかどうかを判断します。
final byte[] array = {10, 20, 30, 40};
final var buffer = ByteBuffer.wrap(array);
System.out.println(buffer instanceof Buffer); // true
buffer.limit(3);
System.out.println(buffer); // java.nio.HeapByteBuffer[pos=0 lim=3 cap=4]
System.out.println(buffer.hasRemaining()); // true
System.out.println(buffer.remaining()); // 3
System.out.println(buffer.get()); // 10
System.out.println(buffer); // java.nio.HeapByteBuffer[pos=1 lim=3 cap=4]
System.out.println(buffer.hasRemaining()); // true
System.out.println(buffer.remaining()); // 2
System.out.println(buffer.get()); // 20
System.out.println(buffer); // java.nio.HeapByteBuffer[pos=2 lim=3 cap=4]
System.out.println(buffer.hasRemaining()); // true
System.out.println(buffer.remaining()); // 1
System.out.println(buffer.get()); // 30
System.out.println(buffer); // java.nio.HeapByteBuffer[pos=3 lim=3 cap=4]
System.out.println(buffer.hasRemaining()); // false
System.out.println(buffer.remaining()); // 0
abstract boolean isDirect ()
このバッファがダイレクトであるかどうかを判断します。
final Buffer buffer = ByteBuffer.allocate(5);
System.out.println(buffer.isDirect()); // false
final Buffer buffer = ByteBuffer.allocateDirect(5);
System.out.println(buffer.isDirect()); // true
abstract boolean isReadOnly ()
このバッファが読取り専用であるかどうかを判断します。
final var buffer = IntBuffer.allocate(5);
System.out.println(buffer instanceof Buffer); // true
System.out.println(buffer.isReadOnly()); // false
buffer.put(10);
buffer.put(20);
buffer.put(30);
System.out.println(buffer); // java.nio.HeapIntBuffer[pos=3 lim=5 cap=5]
final var buffer = IntBuffer.allocate(5).asReadOnlyBuffer();
System.out.println(buffer instanceof Buffer); // true
System.out.println(buffer.isReadOnly()); // true
try {
buffer.put(10);
} catch (ReadOnlyBufferException e) {
System.out.println("ReadOnlyBufferException!");
}
// 結果
// ↓
//ReadOnlyBufferException!
final int limit ()
このバッファのリミットを返します。
final byte[] array = {10, 20, 30, 40, 50};
final Buffer buffer = ByteBuffer.wrap(array);
System.out.println(buffer); // java.nio.HeapByteBuffer[pos=0 lim=5 cap=5]
System.out.println(buffer.limit()); // 5
System.out.println(buffer.limit(3)); // java.nio.HeapByteBuffer[pos=0 lim=3 cap=5]
System.out.println(buffer.limit()); // 3
System.out.println(buffer.clear()); // java.nio.HeapByteBuffer[pos=0 lim=5 cap=5]
System.out.println(buffer.limit()); // 5
final byte[] array = {10, 20, 30, 40, 50};
final var buffer = ByteBuffer.wrap(array);
System.out.println(buffer instanceof Buffer); // true
System.out.println(buffer.limit(3)); // java.nio.HeapByteBuffer[pos=0 lim=3 cap=5]
System.out.println(buffer.get()); // 10
System.out.println(buffer.get()); // 20
System.out.println(buffer.get()); // 30
try {
final var ret = buffer.get();
} catch (BufferUnderflowException e) {
System.out.println("BufferUnderflowException!");
}
// 結果
// ↓
//BufferUnderflowException!
Buffer limit (int newLimit)
このバッファのリミットを設定します。
このメソッドの使用例は、limit() にまとめて記載しました。
そちらのAPI使用例をご参照ください。
Buffer mark ()
このバッファの現在位置にマークを設定します。
final byte[] array = {10, 20, 30, 40, 50};
final var buffer = ByteBuffer.wrap(array);
System.out.println(buffer instanceof Buffer); // true
System.out.println(buffer.get()); // 10
System.out.println(buffer.get()); // 20
System.out.println(buffer.position()); // 2
System.out.println(buffer.mark()); // java.nio.HeapByteBuffer[pos=2 lim=5 cap=5]
System.out.println(buffer.get()); // 30
System.out.println(buffer.get()); // 40
System.out.println(buffer.get()); // 50
System.out.println(buffer.position()); // 5
System.out.println(buffer.reset()); // java.nio.HeapByteBuffer[pos=2 lim=5 cap=5]
System.out.println(buffer.get()); // 30
System.out.println(buffer.get()); // 40
System.out.println(buffer.get()); // 50
final int position ()
このバッファの位置を返します。
final byte[] array = {10, 20, 30, 40, 50};
final var buffer = ByteBuffer.wrap(array);
System.out.println(buffer instanceof Buffer); // true
System.out.println(buffer.position()); // 0
System.out.println(buffer.get()); // 10
System.out.println(buffer.position()); // 1
System.out.println(buffer.get()); // 20
System.out.println(buffer.position()); // 2
System.out.println(buffer.get()); // 30
System.out.println(buffer.position()); // 3
System.out.println(buffer.get()); // 40
System.out.println(buffer.position()); // 4
System.out.println(buffer.get()); // 50
System.out.println(buffer.position()); // 5
System.out.println(buffer.position(3)); // java.nio.HeapByteBuffer[pos=3 lim=5 cap=5]
System.out.println(buffer.get()); // 40
System.out.println(buffer.position()); // 4
System.out.println(buffer.get()); // 50
System.out.println(buffer.position()); // 5
Buffer position (int newPosition)
このバッファの位置を設定します。
このメソッドの使用例は、position() にまとめて記載しました。
そちらのAPI使用例をご参照ください。
final int remaining ()
現在位置からリミットまでに存在する要素の数を返します。
このメソッドの使用例は、hasRemaining() にまとめて記載しました。
そちらのAPI使用例をご参照ください。
Buffer reset ()
バッファの位置を以前にマークした位置に戻します。
このメソッドの使用例は、mark() にまとめて記載しました。
そちらのAPI使用例をご参照ください。
Buffer rewind ()
このバッファをリワインド(巻き戻し)します。
関連 : clear()
final int[] array = {10, 20, 30, 40, 50};
final Buffer buffer = IntBuffer.wrap(array);
buffer.position(2);
buffer.limit(4);
System.out.println(buffer.position()); // 2
System.out.println(buffer.limit()); // 4
System.out.println(buffer.rewind()); // java.nio.HeapIntBuffer[pos=0 lim=4 cap=5]
System.out.println(buffer.position()); // 0
System.out.println(buffer.limit()); // 4
abstract Buffer slice ()
内容がこのバッファ内容の共有されたサブシーケンスである新しいバッファを作成します。
final byte[] array = {10, 20, 30, 40, 50};
final var buffer = ByteBuffer.wrap(array);
System.out.println(buffer instanceof Buffer); // true
buffer.position(1);
buffer.limit(4);
final var sliced = buffer.slice();
System.out.println(sliced instanceof Buffer); // true
System.out.println(buffer); // java.nio.HeapByteBuffer[pos=1 lim=4 cap=5]
System.out.println(sliced); // java.nio.HeapByteBuffer[pos=0 lim=3 cap=3]
System.out.println(buffer.get()); // 20
System.out.println(buffer.get()); // 30
System.out.println(buffer.get()); // 40
System.out.println(buffer.hasRemaining()); // false
System.out.println(sliced.get()); // 20
System.out.println(sliced.get()); // 30
System.out.println(sliced.get()); // 40
System.out.println(sliced.hasRemaining()); // false
abstract Buffer slice (int index, int length)
内容がこのバッファ内容の共有されたサブシーケンスである新しいバッファを作成します。
final byte[] array = {10, 20, 30, 40, 50};
final var buffer = ByteBuffer.wrap(array);
System.out.println(buffer instanceof Buffer); // true
final var sliced = buffer.slice(2, 3);
System.out.println(sliced instanceof Buffer); // true
System.out.println(buffer); // java.nio.HeapByteBuffer[pos=0 lim=5 cap=5]
System.out.println(sliced); // java.nio.HeapByteBuffer[pos=0 lim=3 cap=3]
System.out.println(buffer.get()); // 10
System.out.println(buffer.get()); // 20
System.out.println(buffer.get()); // 30
System.out.println(buffer.get()); // 40
System.out.println(buffer.get()); // 50
System.out.println(buffer.hasRemaining()); // false
System.out.println(sliced.get()); // 30
System.out.println(sliced.get()); // 40
System.out.println(sliced.get()); // 50
System.out.println(sliced.hasRemaining()); // false