java.nio.charset
類別 CoderResult

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

public class CoderResult
extends Object

coder 結果狀態的描述。

charset coder（即解碼器或編碼器）使用輸入緩衝區中的位元組（或字元）、對它們進行轉換，並將結果字元（或位元組）寫入輸出緩衝區。編碼進程終止的原因是以下四類別之一，這些原因由此類別的實例描述：

• 當沒有更多的輸入要處理時，或者當現有的輸入不足而需要其他的輸入時報告下溢（Underflow）。這種情況用唯一的結果物件 UNDERFLOW 表示，該物件的 isUnderflow 方法返回 true。

• 當輸出緩衝區沒有足夠的剩餘空間時報告溢位（Overflow）。這種情況用唯一的結果物件 OVERFLOW 表示，該物件的 isOverflow 方法返回 true。

• 當輸入單元序列不是格式良好時報告錯誤的輸入錯誤。這種錯誤用此類別的實例來描述，該類別的 isMalformed 方法返回 true，該類別的 length 方法返回錯誤序列的長度。對所有的給定長度的錯誤輸入錯誤，有此類別的一個唯一實例描述。

• 當表示一個字元的輸入單元序列不能在輸出 charset 中表示時報告不可映射的字元錯誤。這種錯誤用此類別的實例描述，該類別的 isUnmappable 方法返回 true，該類別的 length 方法返回表示不可映射的字元的輸入序列的長度。對所有的給定長度的不可映射的字元錯誤，有此類別的一個唯一實例描述。

為了方便，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) 靜態處理器方法，返回描述給定長度的錯誤輸入錯誤的唯一物件。
void	throwException() 拋出相應於此物件描述的結果的異常。
String	toString() 返回描述此 CoderResult 的字元串。
static CoderResult	unmappableForLength(int length) 靜態處理器方法，返回描述給定長度的不可映射的字元錯誤的唯一物件。

從類別 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()

返回描述此 CoderResult 的字元串。

覆寫：

類別 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)

靜態處理器方法，返回描述給定長度的錯誤輸入錯誤的唯一物件。

返回：

請求的 CoderResult 物件

unmappableForLength

public static CoderResult unmappableForLength(int length)

靜態處理器方法，返回描述給定長度的不可映射的字元錯誤的唯一物件。

返回：

請求的 CoderResult 物件

throwException

public void throwException()
                    throws CharacterCodingException

拋出相應於此物件描述的結果的異常。

拋出：

BufferUnderflowException - 如果此物件是 UNDERFLOW

BufferOverflowException - 如果此物件是 OVERFLOW

MalformedInputException - 如果此物件表示一個錯誤輸入錯誤；該異常的長度值是此物件的長度值

UnmappableCharacterException - 如果此物件表示一個不可映射的字元錯誤；該異常的長度值是此物件的長度值

CharacterCodingException