モジュール java.base
パッケージ 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()
      このコーダーの結果を説明する文字列を返します。
      オーバーライド:
      toString 、クラス:  Object
      戻り値:
      説明文字列

    • 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ファクトリ・メソッドです。
      パラメータ:
      length - 指定された長さ
      戻り値:
      要求されたCoder Resultオブジェクト

    • unmappableForLength

      public static CoderResult unmappableForLength​(int length)
      指定された長さのマップ不可文字エラーを表した一意のオブジェクトを返すstaticファクトリ・メソッドです。
      パラメータ:
      length - 指定された長さ
      戻り値:
      要求されたCoder Resultオブジェクト

    • throwException

      public void throwException() throws CharacterCodingException
      このオブジェクトが示す結果に応じて例外をスローします。
      例外:
      BufferUnderflowException - このオブジェクトがUNDERFLOWの場合
      BufferOverflowException - このオブジェクトがOVERFLOWの場合
      MalformedInputException - このオブジェクトが不正入力エラーを示す場合、例外の長さの値はこのオブジェクトの長さと同じになる
      UnmappableCharacterException - このオブジェクトがマップ不可文字エラーを示す場合、例外の長さの値はこのオブジェクトの長さと同じになる
      CharacterCodingException