java.nio.charset
クラス CoderResult

java.lang.Object
  java.nio.charset.CoderResult

public class CoderResult
extends Object

コーダーの結果状態の説明です。

文字セットのコーダー (デコーダまたはエンコーダ) は、入力バッファー内のバイトまたは文字を消費し、変換して、結果として得られる文字またはバイトを出力バッファーに書き込みます。コーディングプロセスは、次の 4 つのカテゴリのいずれかで終了します。なお、これらは、このクラスのインスタンスによって表されます。

• 「アンダーフロー」。処理する入力がこれ以上なくなった場合、または入力内容が不完全で追加入力が必要な場合に報告されます。この条件は、一意の結果オブジェクト UNDERFLOW の isUnderflow メソッドが true を返すことによって表されます。

• 「オーバーフロー」。出力バッファーの容量が不足したときに報告されます。この条件は、一意の結果オブジェクト OVERFLOW の isOverflow メソッドが true を返すことによって表されます。

• 「不正入力エラー」。入力ユニットのシーケンスが不正な場合に報告されます。こうしたエラーは、このクラスのインスタンスの isMalformed メソッドが true、length メソッドが不正なシーケンスの長さを返すことによって表されます。特定の長さの不正入力エラーはすべて、このクラスの一意のインスタンス 1 個で表されます。

• 「マップ不可文字エラー」。入力ユニットのシーケンスが、出力文字セットで表現できない文字であるときに報告されます。こうしたエラーは、このクラスのインスタンスの isUnmappable メソッドが true を返すことによって表され、length メソッドはマップ不可文字のある入力シーケンスの長さを返します。特定の長さのマップ不可文字エラーはすべて、このクラスの一意のインスタンス 1 個で表されます。

便宜上、isError メソッドは、不正入力エラーやマップ不可文字エラーを示す結果オブジェクトに対しては true、アンダーフロー条件やオーバーフロー条件を示す結果オブジェクトに対しては false を返します。

導入されたバージョン:

1.4

フィールドの概要

static CoderResult	OVERFLOW オーバーフローを示す結果オブジェクトで、出力バッファーの容量が不足している状態を示します。
static CoderResult	UNDERFLOW アンダーフローを示す結果オブジェクトで、入力バッファーが完全に消費された状態か、入力バッファーがまだ空でない場合は、追加入力が必要な状態を示します。

メソッドの概要

boolean	isError() このオブジェクトがエラー条件を示しているかどうかを判断します。
boolean	isMalformed() このオブジェクトが不正入力エラーを示しているかどうかを判断します。
boolean	isOverflow() このオブジェクトがオーバーフロー条件を示しているかどうかを判断します。
boolean	isUnderflow() このオブジェクトがアンダーフロー条件を示しているかどうかを判断します。
boolean	isUnmappable() このオブジェクトがマップ不可文字エラーを示しているかどうかを判断します。
int	length() このオブジェクトによって表されているエラー入力の長さを返します (オプション)。
static CoderResult	malformedForLength(int length) 指定された長さの不正入力エラーを表した一意のオブジェクトを返す static ファクトリメソッドです。
void	throwException() このオブジェクトが示す結果に応じて例外をスローします。
String	toString() このコーダーの結果を説明する文字列を返します。
static CoderResult	unmappableForLength(int length) 指定された長さのマップ不可文字エラーを表した一意のオブジェクトを返す static ファクトリメソッドです。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

フィールドの詳細

UNDERFLOW

public static final CoderResult UNDERFLOW

アンダーフローを示す結果オブジェクトで、入力バッファーが完全に消費された状態か、入力バッファーがまだ空でない場合は、追加入力が必要な状態を示します。

OVERFLOW

public static final CoderResult OVERFLOW

オーバーフローを示す結果オブジェクトで、出力バッファーの容量が不足している状態を示します。

メソッドの詳細

toString

public String toString()

このコーダーの結果を説明する文字列を返します。

オーバーライド:

クラス Object 内の toString

戻り値:

説明文字列

isUnderflow

public boolean isUnderflow()

このオブジェクトがアンダーフロー条件を示しているかどうかを判断します。

戻り値:

このオブジェクトがアンダーフロー条件を示している場合にかぎり true

isOverflow

public boolean isOverflow()

このオブジェクトがオーバーフロー条件を示しているかどうかを判断します。

戻り値:

このオブジェクトがオーバーフロー条件を示している場合にかぎり true

isError

public boolean isError()

このオブジェクトがエラー条件を示しているかどうかを判断します。

戻り値:

このオブジェクトが不正入力エラーまたはマップできない文字エラーを示している場合にかぎり true

isMalformed

public boolean isMalformed()

このオブジェクトが不正入力エラーを示しているかどうかを判断します。

戻り値:

このオブジェクトが不正入力エラーを示している場合にかぎり true

isUnmappable

public boolean isUnmappable()

このオブジェクトがマップ不可文字エラーを示しているかどうかを判断します。

戻り値:

このオブジェクトがマップできない文字エラーを示している場合にかぎり true

length

public int length()

このオブジェクトによって表されているエラー入力の長さを返します (オプション)。

戻り値:

エラー入力の長さ (正の整数)

例外:

UnsupportedOperationException - このオブジェクトがエラー条件を示していない場合、すなわち isError が true を返さない場合

malformedForLength

public static CoderResult malformedForLength(int length)

指定された長さの不正入力エラーを表した一意のオブジェクトを返す static ファクトリメソッドです。

戻り値:

要求された Coder Result オブジェクト

unmappableForLength

public static CoderResult unmappableForLength(int length)

指定された長さのマップ不可文字エラーを表した一意のオブジェクトを返す static ファクトリメソッドです。

戻り値:

要求された Coder Result オブジェクト

throwException

public void throwException()
                    throws CharacterCodingException

このオブジェクトが示す結果に応じて例外をスローします。

例外:

BufferUnderflowException - このオブジェクトが UNDERFLOW である場合

BufferOverflowException - このオブジェクトが OVERFLOW である場合

MalformedInputException - このオブジェクトが不正入力エラーを示す場合、例外の長さの値はこのオブジェクトの長さと同じになる

UnmappableCharacterException - このオブジェクトがマップできない文字エラーを示す場合、例外の長さの値はこのオブジェクトの長さと同じになる

CharacterCodingException