模块  java.base
软件包  java.nio.charset

Class CoderResult

  • public class CoderResult
extends Object
    编码器的结果状态的描述。

    字符集编码器，即解码器或编码器，从输入缓冲器中消耗字节（或字符），转换它们，并将结果字符（或字节）写入输出缓冲区。 编码过程终止于以下四类原因之一，这些原因由此类实例描述：

    • 当没有更多要处理的输入，或者输入不足并且需要额外输入时，将报告下溢 。 该条件由唯一结果对象UNDERFLOW表示 ，其isUnderflow方法返回true 。

    • 当输出缓冲区中剩余空间不足时，将报告溢出 。 该条件由唯一结果对象OVERFLOW表示 ，其isOverflow方法返回true 。

    • 当一系列输入单元格式不正确时，会报告格式错误的输入错误 。 此类错误由此类的实例描述，其isMalformed方法返回true ，其length方法返回格式错误的序列的长度。 对于给定长度的所有格式错误的输入错误，此类有一个唯一的实例。

    • 当输入单元序列表示无法在输出字符集中表示的字符时，将报告不可映射字符错误 。 此类错误由此类的实例描述，其isUnmappable方法返回true ，其length方法返回表示不可映射字符的输入序列的长度。 对于给定长度的所有不可映射的字符错误，此类有一个唯一的实例。

    为方便起见， isError方法返回true用于描述格式错误输入和不可映射字符错误的结果对象，但false用于描述下溢或溢出条件的错误。

    从以下版本开始：
    1.4

    • 字段详细信息

      • 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 if此且仅当此对象表示不可映射字符错误时

      • length

        public int length()
        返回此对象描述的错误输入的长度 （可选操作） 。
        结果
        错误输入的长度，正整数
        异常
        UnsupportedOperationException - 如果此对象未描述错误条件，即 isError未返回 true

      • malformedForLength

        public static CoderResult malformedForLength​(int length)
        静态工厂方法，返回描述给定长度的格式错误输入错误的唯一对象。
        参数
        length - 给定长度
        结果
        请求的编码器结果对象

      • unmappableForLength

        public static CoderResult unmappableForLength​(int length)
        静态工厂方法，返回描述给定长度的不可映射字符错误的唯一结果对象。
        参数
        length - 给定长度
        结果
        请求的编码器结果对象