java.nio
クラス CharBuffer

java.lang.Object
  java.nio.Buffer
      java.nio.CharBuffer

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

Appendable, CharSequence, Comparable<CharBuffer>, Readable

public abstract class CharBuffer
extends Buffer
implements Comparable<CharBuffer>, Appendable, CharSequence, Readable

文字バッファーです。

このクラスは、文字バッファーに対する操作を 4 つのカテゴリに分類します。

• 単一 char 値の読み込みと書き込みを行う絶対および相対 get/put メソッド

• 連続した char シーケンスをこのバッファーから配列へと転送する相対一括 get メソッド

• 連続した char シーケンスを char 配列、文字列、またはその他の文字バッファーからこのバッファーへと転送する相対一括 put メソッド

• 文字バッファーの圧縮、複製、スライス用メソッド

文字バッファーを作成するには、バッファーのコンテンツに容量を割り当てる 割り当て 操作を実行するか、 既存の char 配列や文字列をバッファー内に 「ラップ」 するか、または既存の byte バッファーの「ビュー」を作成します。

byte バッファーと同様に、文字バッファーにも「ダイレクト」バッファーと「非ダイレクト」バッファーがあります。このクラスの wrap メソッドで作成された文字バッファーは非ダイレクトバッファーになります。byte バッファーのビューとして作成された文字バッファーは、byte バッファーがダイレクトバッファーである場合に限りダイレクトバッファーになります。文字バッファーがダイレクトバッファーであるかどうかは、isDirect メソッドを呼び出すことで判断できます。

このクラスは CharSequence インタフェースを実装しています。 このため、文字シーケンスが受け付けられる場所であればどこでも、文字バッファーを使用できます。 たとえば、正規表現のパッケージ java.util.regex での使用が可能です。

このクラスのメソッドのうち戻り値を返さないものは、自身を呼び出したバッファーの情報を返します。これを応用して、メソッド呼び出しを連鎖させることができます。 たとえば、次のような連続した文があるとしましょう。

 cb.put("text/");
 cb.put(subtype);
 cb.put("; charset=");
 cb.put(enc);

これらは、次の一文で置き換えられます。

 cb.put("text/").put(subtype).put("; charset=").put(enc);

導入されたバージョン:

1.4

メソッドの概要

static CharBuffer	allocate(int capacity) 新しい文字バッファーを割り当てます。
CharBuffer	append(char c) 指定された文字をこのバッファーに追加します (オプション)。
CharBuffer	append(CharSequence csq) 指定された文字シーケンスをこのバッファーに追加します (オプション)。
CharBuffer	append(CharSequence csq, int start, int end) 指定された文字シーケンスのサブシーケンスをこのバッファーに追加します (オプション)。
char[]	array() 現在のバッファーを補助する char 配列を返します (オプション)。
int	arrayOffset() 現在のバッファーの補助配列内にある、このバッファーの最初の要素のオフセットを返します (オプション)。
abstract CharBuffer	asReadOnlyBuffer() 現在のバッファーのコンテンツを共有する新しい読み込み専用文字バッファーを作成します。
char	charAt(int index) 現在位置からの相対位置として指定されたインデックス位置にある文字を読み込みます。
abstract CharBuffer	compact() 現在のバッファーを圧縮します (オプション)。
int	compareTo(CharBuffer that) 現在のバッファーを別のバッファーと比較します。
abstract CharBuffer	duplicate() 現在のバッファーのコンテンツを共有する新しい文字バッファーを作成します。
boolean	equals(Object ob) 現在のバッファーが別のオブジェクトと等価であるかどうかを判断します。
abstract char	get() 相対「get」メソッドです。
CharBuffer	get(char[] dst) 相対一括「get」メソッドです。
CharBuffer	get(char[] dst, int offset, int length) 相対一括「get」メソッドです。
abstract char	get(int index) 絶対「get」メソッドです。
boolean	hasArray() 現在のバッファーがアクセス可能な char 配列に連動するかどうかを判断します。
int	hashCode() 現在のバッファーの現在のハッシュコードを返します。
abstract boolean	isDirect() 現在の文字バッファーがダイレクトバッファーであるかどうかを判断します。
int	length() 現在の文字バッファーのバッファー長を返します。
abstract ByteOrder	order() 現在のバッファーのバイト順序を取得します。
abstract CharBuffer	put(char c) 相対「put」メソッドです (オプション)。
CharBuffer	put(char[] src) 相対一括「put」メソッドです (オプション)。
CharBuffer	put(char[] src, int offset, int length) 相対一括「put」メソッドです (オプション)。
CharBuffer	put(CharBuffer src) 相対一括「put」メソッドです (オプション)。
abstract CharBuffer	put(int index, char c) 絶対「put」メソッドです (オプション)。
CharBuffer	put(String src) 相対一括「put」メソッドです (オプション)。
CharBuffer	put(String src, int start, int end) 相対一括「put」メソッドです (オプション)。
int	read(CharBuffer target) 指定された文字バッファーに文字列を読み込みます。
abstract CharBuffer	slice() 現在のバッファーのコンテンツの共有のサブシーケンスをコンテンツとする新しい文字バッファーを作成します。
abstract CharSequence	subSequence(int start, int end) 現在のバッファーの指定されたサブシーケンス (現在位置からの相対位置) を表す新しい文字バッファーを作成します。
String	toString() 現在のバッファー内に残っている文字を含む文字列を返します。
static CharBuffer	wrap(char[] array) char 配列をバッファーにラップします。
static CharBuffer	wrap(char[] array, int offset, int length) char 配列をバッファーにラップします。
static CharBuffer	wrap(CharSequence csq) 文字シーケンスをバッファーにラップします。
static CharBuffer	wrap(CharSequence csq, int start, int end) 文字シーケンスをバッファーにラップします。

クラス 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

メソッドの詳細

allocate

public static CharBuffer allocate(int capacity)

新しい文字バッファーを割り当てます。

新しいバッファーの位置は 0、リミットは容量と同じ値になります。 マークは定義されません。このバッファーは補助配列を利用し、その配列オフセットは 0 になります。

パラメータ:

capacity - 新しいバッファーの容量 (文字数)

戻り値:

新しい文字バッファー

例外:

IllegalArgumentException - capacity が負の整数である場合

wrap

public static CharBuffer wrap(char[] array,
                              int offset,
                              int length)

char 配列をバッファーにラップします。

新しいバッファーは指定された char 配列によって補助されます。 バッファーに変更を加えると配列も変更され、配列に変更を加えるとバッファーも変更されます。新しいバッファーの容量は array.length、位置は offset、リミットは offset + length になります。 マークは定義されません。指定された配列が補助配列となり、その配列オフセットは 0 になります。

パラメータ:

array - 新しいバッファーを補助する配列

offset - 使用するサブ配列のオフセット。array.length 以下の負でない値でなければならない。新しいバッファーの位置は、この値に設定される

length - 使用するサブ配列の長さ。 array.length - offset 以下の負でない値でなければならない。新しいバッファーのリミットは、offset + length に設定される

戻り値:

新しい文字バッファー

例外:

IndexOutOfBoundsException - offset パラメータと length パラメータの前提条件が満たされていない場合

wrap

public static CharBuffer wrap(char[] array)

char 配列をバッファーにラップします。

新しいバッファーは指定された char 配列によって補助されます。 バッファーに変更を加えると配列も変更され、配列に変更を加えるとバッファーも変更されます。新しいバッファーの容量とリミットは array.length、位置は 0 になります。 マークは定義されません。指定された配列が補助配列となり、その配列オフセットは 0 になります。

パラメータ:

array - 現在のバッファーを補助する配列

戻り値:

新しい文字バッファー

read

public int read(CharBuffer target)
         throws IOException

指定された文字バッファーに文字列を読み込みます。バッファーは、put 操作の結果により変更される以外は、文字列そのままのリポジトリとして使用されます。バッファーのフリッピング (反転) やリワインド (巻き戻し) は行われません。

定義:

インタフェース Readable 内の read

パラメータ:

target - 文字列を読み込むバッファー

戻り値:

バッファーに追加された文字の数。文字のソースが最後の位置にある場合は -1

例外:

IOException - 入出力エラーが発生した場合

NullPointerException - target が null の場合

ReadOnlyBufferException - target が読み取り専用バッファーの場合

導入されたバージョン:

1.5

wrap

public static CharBuffer wrap(CharSequence csq,
                              int start,
                              int end)

文字シーケンスをバッファーにラップします。

新しい読み取り専用バッファーのコンテンツは、指定された文字シーケンスのコンテンツになります。バッファーの容量は csq.length()、位置は start、リミットは end になります。 マークは定義されません。

パラメータ:

csq - 作成される新しい文字バッファーの元になる文字シーケンス

start - 使用される最初の文字を示すインデックス。 csq.length() 以下の負でない値でなければならない。新しいバッファーの位置は、この値に設定される

end - 使用される最後の文字の次の文字を示すインデックス。start 以上、csq.length() 以下の値でなければならない。新しいバッファーのリミットは、この値に設定される

戻り値:

新しい文字バッファー

例外:

IndexOutOfBoundsException - start パラメータと end パラメータの前提条件が満たされていない場合

wrap

public static CharBuffer wrap(CharSequence csq)

文字シーケンスをバッファーにラップします。

新しい読み取り専用バッファーのコンテンツは、指定された文字シーケンスのコンテンツになります。新しいバッファーの容量とリミットは csq.length()、位置は 0 になります。 マークは定義されません。

パラメータ:

csq - 作成される新しい文字バッファーの元になる文字シーケンス

戻り値:

新しい文字バッファー

slice

public abstract CharBuffer slice()

現在のバッファーのコンテンツの共有のサブシーケンスをコンテンツとする新しい文字バッファーを作成します。

新しいバッファーのコンテンツは、現在のバッファーの現在位置から始まります。現在のバッファーのコンテンツに変更を加えると、その内容が新しいバッファーに反映されます。 新しいバッファーのコンテンツに変更を加えると、その内容が現在のバッファーに反映されます。 2 つのバッファーの位置、リミット、マークの値はそれぞれ異なります。

新しいバッファーの位置は 0、容量とリミットはこのバッファー内に残っている文字数になります。 マークは定義されません。新しいバッファーは、現在のバッファーがダイレクトバッファーである場合に限りダイレクトバッファーになります。 また、現在のバッファーが読み取り専用バッファーである場合に限り読み取り専用バッファーになります。

戻り値:

新しい文字バッファー

duplicate

public abstract CharBuffer duplicate()

現在のバッファーのコンテンツを共有する新しい文字バッファーを作成します。

新しいバッファーのコンテンツは、現在のバッファーのコンテンツと同じになります。現在のバッファーのコンテンツに変更を加えると、その内容が新しいバッファーに反映されます。 新しいバッファーのコンテンツに変更を加えると、その内容が現在のバッファーに反映されます。 2 つのバッファーの位置、リミット、マークの値はそれぞれ異なります。

新しいバッファーの容量、リミット、位置、マークの値は、現在のバッファーの対応する値と同じになります。新しいバッファーは、現在のバッファーがダイレクトバッファーである場合に限りダイレクトバッファーになります。 また、現在のバッファーが読み取り専用バッファーである場合に限り読み取り専用バッファーになります。

戻り値:

新しい文字バッファー

asReadOnlyBuffer

public abstract CharBuffer asReadOnlyBuffer()

現在のバッファーのコンテンツを共有する新しい読み込み専用文字バッファーを作成します。

新しいバッファーのコンテンツは、現在のバッファーのコンテンツと同じになります。現在のバッファーのコンテンツに変更を加えると、その内容が新しいバッファーに反映されます。 しかし、新しいバッファー自体は読み取り専用であり、その共有コンテンツを変更することはできません。2 つのバッファーの位置、リミット、マークの値はそれぞれ異なります。

新しいバッファーの容量、リミット、位置、マークの値は、現在のバッファーの対応する値と同じになります。

現在のバッファーが読み取り専用の場合、このメソッドの動作は duplicate メソッドとまったく同じになります。

戻り値:

新しい読み込み専用文字バッファー

get

public abstract char get()

相対「get」メソッドです。バッファーの現在位置の文字を読み込み、現在位置の値を増加します。

戻り値:

バッファーの現在位置の文字

例外:

BufferUnderflowException - バッファーの現在位置がリミット以上である場合

put

public abstract CharBuffer put(char c)

相対「put」メソッドです (オプション)。

バッファーの現在位置に指定された文字を書き込み、現在位置の値を増加します。

パラメータ:

c - 書き込まれる文字

戻り値:

現在のバッファー

例外:

BufferOverflowException - 現在のバッファーの現在位置がリミット以上である場合

ReadOnlyBufferException - 現在のバッファーが読み込み専用バッファーである場合

get

public abstract char get(int index)

絶対「get」メソッドです。指定されたインデックス位置の文字を読み込みます。

パラメータ:

index - 文字の読み込み位置を示すインデックス

戻り値:

指定されたインデックス位置の文字

例外:

IndexOutOfBoundsException - index が負の数である場合、またはバッファーのリミット以上である場合

put

public abstract CharBuffer put(int index,
                               char c)

絶対「put」メソッドです (オプション)。

現在のバッファーの指定されたインデックス位置に指定された文字を書き込みます。

パラメータ:

index - 文字の書き込み先を示すインデックス

c - 書き込まれる文字

戻り値:

現在のバッファー

例外:

IndexOutOfBoundsException - index が負の数である場合、またはバッファーのリミット以上である場合

ReadOnlyBufferException - 現在のバッファーが読み込み専用バッファーである場合

get

public CharBuffer get(char[] dst,
                      int offset,
                      int length)

相対一括「get」メソッドです。

このメソッドは、現在のバッファーから指定された配列へ文字を転送します。このバッファー内に残っている文字数が要求に満たない場合 (つまり、length > remaining() である場合)、文字は一切転送されず、BufferUnderflowException がスローされます。

それ以外の場合、このメソッドは、現在のバッファーの現在位置から length 文字を指定された配列の指定されたオフセット位置へコピーします。そのたびに、現在のバッファーの位置が length ずつ増加します。

このメソッドを src.get(dst, off, len) の形式で呼び出すと、次のループとまったく同じ結果になります。

     for (int i = off; i < off + len; i++)
         dst[i] = src.get(); 

ただし、現在のバッファー内に残っている文字数が十分であることを最初に確認する動作は、このメソッド固有です。 また、このメソッドのほうがループよりも効率的です。

パラメータ:

dst - 文字の書き込み先となる配列

offset - 最初の文字の書き込み先となる配列内のオフセット。dst.length 以下の負でない値でなければならない

length - 指定された配列に書き込まれる最大文字数。dst.length - offset 以下の負でない値でなければならない

戻り値:

現在のバッファー

例外:

BufferUnderflowException - 現在のバッファー内に残っている文字数が length よりも少ない場合

IndexOutOfBoundsException - offset パラメータと length パラメータの前提条件が満たされていない場合

get

public CharBuffer get(char[] dst)

相対一括「get」メソッドです。

このメソッドは、現在のバッファーから指定された配列へ文字を転送します。このメソッドを src.get(a) の形式で呼び出すと、次の呼び出しと同じ結果になります。

     src.get(a, 0, a.length) 

戻り値:

現在のバッファー

例外:

BufferUnderflowException - 現在のバッファー内に残っている文字数が length よりも少ない場合

put

public CharBuffer put(CharBuffer src)

相対一括「put」メソッドです (オプション)。

このメソッドは、指定されたソースバッファー内に残っている文字 をこのバッファーへ転送します。ソースバッファー内に残っている文字数がこのバッファー内に残っている文字数よりも多い場合 (つまり、src.remaining() > remaining() である場合)、文字は一切転送されず、BufferOverflowException がスローされます。

それ以外の場合、このメソッドは、指定されたバッファーの現在位置から現在のバッファーの現在位置へ n = src.remaining() 文字をコピーします。そのたびに、両方のバッファーの位置が n ずつ増加します。

このメソッドを dst.put(src) の形式で呼び出すと、次のループとまったく同じ結果になります。

     while (src.hasRemaining())
         dst.put(src.get()); 

ただし、現在のバッファー内に十分な容量があることを最初に確認する動作は、このメソッドに固有です。 また、このメソッドのほうがループよりもずっと効率的です。

パラメータ:

src - 文字の読み込み先となるソースバッファー (現在のバッファー以外)

戻り値:

現在のバッファー

例外:

BufferOverflowException - 現在のバッファーに、ソースバッファー内に残っている文字を格納できるだけの容量がない場合

IllegalArgumentException - ソースバッファーとして現在のバッファーを指定した場合

ReadOnlyBufferException - 現在のバッファーが読み込み専用バッファーである場合

put

public CharBuffer put(char[] src,
                      int offset,
                      int length)

相対一括「put」メソッドです (オプション)。

このメソッドは、指定されたソース配列からこのバッファーへ文字を転送します。配列からコピーする文字数がこのバッファー内に残っている文字数より多い場合 (つまり、length > remaining() である場合)、文字は一切転送されず、BufferOverflowException がスローされます。

それ以外の場合、このメソッドは、指定された配列の指定されたオフセット位置から現在のバッファーの現在位置へ length 文字をコピーします。そのたびに、現在のバッファーの位置が length ずつ増加します。

このメソッドを dst.put(src, off, len) の形式で呼び出すと、次のループとまったく同じ結果になります。

     for (int i = off; i < off + len; i++)
         dst.put(a[i]); 

ただし、現在のバッファー内に十分な容量があることを最初に確認する動作は、このメソッドに固有です。 また、このメソッドのほうがループよりもずっと効率的です。

パラメータ:

src - 文字の読み込み先となる配列

offset - 最初の文字の読み込み先となる配列内のオフセット。array.length 以下の負でない値でなければならない

length - 指定された配列から読み取られる文字数。array.length - offset 以下の負でない値でなければならない

戻り値:

現在のバッファー

例外:

BufferOverflowException - 現在のバッファー内に残っている容量が不足している場合

IndexOutOfBoundsException - offset パラメータと length パラメータの前提条件が満たされていない場合

ReadOnlyBufferException - 現在のバッファーが読み込み専用バッファーである場合

put

public final CharBuffer put(char[] src)

相対一括「put」メソッドです (オプション)。

このメソッドは、ソースとなる指定された char 配列のコンテンツ全体を現在のバッファーへ転送します。このメソッドを dst.put(a) の形式で呼び出すと、次の呼び出しと同じ結果になります。

     dst.put(a, 0, a.length) 

戻り値:

現在のバッファー

例外:

BufferOverflowException - 現在のバッファー内に残っている容量が不足している場合

ReadOnlyBufferException - 現在のバッファーが読み込み専用バッファーである場合

put

public CharBuffer put(String src,
                      int start,
                      int end)

相対一括「put」メソッドです (オプション)。

このメソッドは、指定された文字列から現在のバッファーへ文字を転送します。文字列からコピーする文字数が現在のバッファー内に残っている文字数より多い場合 (end - start > remaining())、文字は一切転送されず、BufferOverflowException がスローされます。

それ以外の場合、このメソッドは、指定された文字列の start インデックスから現在のバッファーの現在位置へ n = end - start 文字をコピーします。そのたびに、現在のバッファーの位置が n ずつ増加します。

このメソッドを dst.put(src, start, end) の形式で呼び出すと、次のループとまったく同じ結果になります。

     for (int i = start; i < end; i++)
         dst.put(src.charAt(i)); 

ただし、現在のバッファー内に十分な容量があることを最初に確認する動作は、このメソッドに固有です。 また、このメソッドのほうがループよりもずっと効率的です。

パラメータ:

src - 文字の読み込み先となる文字列

start - 最初の文字の読み込み先となる文字列内のオフセット。string.length 以下の負でない値でなければならない

end - 最後の文字の読み込み先となる文字列内のオフセット + 1。string.length 以下の負でない数でなければならない

戻り値:

現在のバッファー

例外:

BufferOverflowException - 現在のバッファー内に残っている容量が不足している場合

IndexOutOfBoundsException - start パラメータと end パラメータの前提条件が満たされていない場合

ReadOnlyBufferException - 現在のバッファーが読み込み専用バッファーである場合

put

public final CharBuffer put(String src)

相対一括「put」メソッドです (オプション)。

このメソッドは、指定されたソース文字列のコンテンツ全体を現在のバッファーへ転送します。このメソッドを dst.put(s) の形式で呼び出すと、次の呼び出しと同じ結果になります。

     dst.put(s, 0, s.length()) 

戻り値:

現在のバッファー

例外:

BufferOverflowException - 現在のバッファー内に残っている容量が不足している場合

ReadOnlyBufferException - 現在のバッファーが読み込み専用バッファーである場合

hasArray

public final boolean hasArray()

現在のバッファーがアクセス可能な char 配列に連動するかどうかを判断します。

このメソッドの戻り値が true であれば、array メソッドおよび arrayOffset メソッドを安全に呼び出すことができます。

定義:

クラス Buffer 内の hasArray

戻り値:

現在のバッファーが配列に連動しており、読み取り専用でない場合にかぎり true

array

public final char[] array()

現在のバッファーを補助する char 配列を返します (オプション)。

現在のバッファーのコンテンツに変更を加えると、返される配列のコンテンツも変更されます。その逆も同様です。

このメソッドを呼び出す前に hasArray メソッドを呼び出し、現在のバッファーがアクセス可能な補助配列を持っていることを確認します。

定義:

クラス Buffer 内の array

戻り値:

現在のバッファーを補助する配列

例外:

ReadOnlyBufferException - 現在のバッファーが配列に連動しており、しかも読み込み専用である場合

UnsupportedOperationException - 現在のバッファーがアクセス可能な配列を利用しない場合

arrayOffset

public final int arrayOffset()

現在のバッファーの補助配列内にある、このバッファーの最初の要素のオフセットを返します (オプション)。

現在のバッファーが配列に連動していれば、その位置 p が配列のインデックス p + arrayOffset() と一致します。

このメソッドを呼び出す前に hasArray メソッドを呼び出し、現在のバッファーがアクセス可能な補助配列を持っていることを確認します。

定義:

クラス Buffer 内の arrayOffset

戻り値:

現在のバッファーの配列内にある、このバッファーの最初の要素のオフセット

例外:

ReadOnlyBufferException - 現在のバッファーが配列に連動しており、しかも読み込み専用である場合

UnsupportedOperationException - 現在のバッファーがアクセス可能な配列を利用しない場合

compact

public abstract CharBuffer compact()

現在のバッファーを圧縮します (オプション)。

バッファーの現在位置からリミットまでの間に文字が存在する場合、これらをバッファーの先頭にコピーします。つまり、インデックス位置 p = position() の文字がインデックス 0 にコピーされ、インデックス位置 p + 1 の文字がインデックス 1 にコピーされるということです。 インデックス位置 limit() - 1 の文字がインデックス n = limit() - 1 - p にコピーされるまで、同様の処理が繰り返されます。最終的にバッファーの位置は n+1 に設定され、リミットは容量の値と等しくなります。マークは破棄されます。

バッファーの位置は、0 ではなく、コピーされる文字数と等しくなります。 したがって、このメソッドを呼び出したあと、すぐに別の相対「put」メソッドを呼び出すことができます。

戻り値:

現在のバッファー

例外:

ReadOnlyBufferException - 現在のバッファーが読み込み専用バッファーである場合

isDirect

public abstract boolean isDirect()

現在の文字バッファーがダイレクトバッファーであるかどうかを判断します。

定義:

クラス Buffer 内の isDirect

戻り値:

現在のバッファーがダイレクトバッファーである場合にかぎり true

hashCode

public int hashCode()

現在のバッファーの現在のハッシュコードを返します。

文字バッファーのハッシュコードは、バッファー内に残っている要素、すなわち position() 〜 limit() - 1 の要素だけに依存します。

バッファーのハッシュコードはコンテンツ依存型です。 今後バッファーのコンテンツが変更されないことが明らかでないかぎり、バッファーをハッシュマップその他のデータ構造のキーとして使用することは避けてください。

オーバーライド:

クラス Object 内の hashCode

戻り値:

現在のバッファーの現在のハッシュコード

関連項目:

Object.equals(java.lang.Object), Hashtable

equals

public boolean equals(Object ob)

現在のバッファーが別のオブジェクトと等価であるかどうかを判断します。

2 つの文字バッファーは、次の場合にかぎり等価です。

1. 要素の型が同じである

2. バッファー内に残っている要素数が同じである

3. バッファー内に残っている要素のシーケンス (開始位置とは無関係) が各点で等しい (pointwise equal)

文字バッファーが、その他の型のオブジェクトと等価になることはありません。

オーバーライド:

クラス Object 内の equals

パラメータ:

ob - 現在のバッファーと比較するオブジェクト

戻り値:

現在のバッファーが指定されたオブジェクトと等価である場合にかぎり true

関連項目:

Object.hashCode(), Hashtable

compareTo

public int compareTo(CharBuffer that)

現在のバッファーを別のバッファーと比較します。

2 つの文字バッファーを比較する際は、残りの要素のシーケンスが辞書順に比較されます。このとき、双方のバッファー内に残っている各シーケンスの開始位置は考慮されません。

文字バッファーとその他の型のオブジェクトを比較することはできません。

定義:

インタフェース Comparable<CharBuffer> 内の compareTo

パラメータ:

that - the object to be compared.

戻り値:

このバッファーが指定されたバッファーより小さい場合は負の整数、等しい場合は 0、大きい場合は正の整数

toString

public String toString()

現在のバッファー内に残っている文字を含む文字列を返します。

また、結果として得られる文字列の最後の文字は、インデックス位置 limit() - 1 にある文字列になります。 このメソッドを呼び出しても、バッファーの現在位置は変わりません。

定義:

インタフェース CharSequence 内の toString

オーバーライド:

クラス Object 内の toString

戻り値:

指定された文字列

length

public final int length()

現在の文字バッファーのバッファー長を返します。

文字シーケンスとして見た場合、文字バッファーのバッファー長 (文字数) は、位置の値以上、リミットの値より小さい値になります。 この値は remaining() と等価です。

定義:

インタフェース CharSequence 内の length

戻り値:

現在の文字バッファーのバッファー長

charAt

public final char charAt(int index)

現在位置からの相対位置として指定されたインデックス位置にある文字を読み込みます。

定義:

インタフェース CharSequence 内の charAt

パラメータ:

index - 読み取られる文字のインデックス (現在位置からの相対位置)。この値は remaining() 以下の負でない値でなければならない

戻り値:

インデックス位置 position() + index にある文字

例外:

IndexOutOfBoundsException - index の前提条件が満たされていない場合

subSequence

public abstract CharSequence subSequence(int start,
                                         int end)

現在のバッファーの指定されたサブシーケンス (現在位置からの相対位置) を表す新しい文字バッファーを作成します。

新しいバッファーは、現在のバッファーのコンテンツを共有します。 つまり、現在のバッファーのコンテンツが変更可能である場合、一方のバッファーに変更を加えると他方のバッファーも変更されます。 新しいバッファーの容量は現在のバッファーの容量と同じになります。新しいバッファーの位置は position() + start、リミットは position() + end になります。新しいバッファーは、現在のバッファーがダイレクトバッファーである場合に限りダイレクトバッファーになります。 また、現在のバッファーが読み取り専用バッファーである場合に限り読み取り専用バッファーになります。

定義:

インタフェース CharSequence 内の subSequence

パラメータ:

start - サブシーケンス内の最初の文字を示すインデックス (現在位置からの相対位置)。remaining() 以下の負でない値でなければならない

end - サブシーケンス内の最後の文字を示すインデックス (現在位置からの相対位置)。start 以上 remaining() 以下の値でなければならない

戻り値:

新しい文字シーケンス

例外:

IndexOutOfBoundsException - start パラメータと end パラメータの前提条件が満たされていない場合

append

public CharBuffer append(CharSequence csq)

指定された文字シーケンスをこのバッファーに追加します (オプション)。

このメソッドを dst.append(csq) の形式で呼び出した場合、次の呼び出しと同じ結果が得られます。

     dst.put(csq.toString()) 

文字シーケンス csq に対する toString の指定に応じて、シーケンス全体が追加されないこともあります。たとえば、文字バッファーの toString メソッドを呼び出した場合、そのバッファーの位置とリミットによって決まる内容を持つサブシーケンスが返されます。

定義:

インタフェース Appendable 内の append

パラメータ:

csq - 追加される文字シーケンス。csq が null である場合、この文字バッファーに null の 4 文字が追加される

戻り値:

現在のバッファー

例外:

BufferOverflowException - 現在のバッファー内に残っている容量が不足している場合

ReadOnlyBufferException - 現在のバッファーが読み込み専用バッファーである場合

導入されたバージョン:

1.5

append

public CharBuffer append(CharSequence csq,
                         int start,
                         int end)

指定された文字シーケンスのサブシーケンスをこのバッファーに追加します (オプション)。

csq が null でないときに、このメソッドを dst.append(csq, start, end) の形式で呼び出した場合、次の呼び出しと同じ結果が得られます。

     dst.put(csq.subSequence(start, end).toString()) 

定義:

インタフェース Appendable 内の append

パラメータ:

csq - サブシーケンスの追加元の文字シーケンス。csq が null であれば、csq に「null」という 4 文字が含まれているかのように追加される

start - サブシーケンスの最初の文字のインデックス

end - サブシーケンスの最後の文字のあとに続く文字のインデックス

戻り値:

現在のバッファー

例外:

BufferOverflowException - 現在のバッファー内に残っている容量が不足している場合

IndexOutOfBoundsException - start または end が負の値の場合、start が end より大きい場合、または end が csq.length() より大きい場合

ReadOnlyBufferException - 現在のバッファーが読み込み専用バッファーである場合

導入されたバージョン:

1.5

append

public CharBuffer append(char c)

指定された文字をこのバッファーに追加します (オプション)。

このメソッドを dst.append(c) の形式で呼び出した場合、次の呼び出しと同じ結果が得られます。

     dst.put(c) 

定義:

インタフェース Appendable 内の append

パラメータ:

c - 追加される 16 ビット文字

戻り値:

現在のバッファー

例外:

BufferOverflowException - 現在のバッファー内に残っている容量が不足している場合

ReadOnlyBufferException - 現在のバッファーが読み込み専用バッファーである場合

導入されたバージョン:

1.5

order

public abstract ByteOrder order()

現在のバッファーのバイト順序を取得します。

割り当てまたは既存の char 配列のラップによって作成された文字バッファーのバイト順序は、基本となるハードウェアの ネイティブのバイト順序 と同じになります。byte バッファーのビューとして作成された文字バッファーのバイト順序は、ビューを作成した時点の byte バッファーのバイト順序と同じになります。

戻り値:

現在のバッファーのバイト順序