jdk.nio.charset.CoderResult
A description of the result state of a coder.
A charset coder, that is, either a decoder or an encoder, consumes bytes (or characters) from an input buffer, translates them, and writes the resulting characters (or bytes) to an output buffer. A coding process terminates for one of four categories of reasons, which are described by instances of this class:
Underflow is reported when there is no more input to be processed, or there is insufficient input and additional input is required. This condition is represented by the unique result object UNDERFLOW, whose isUnderflow method returns true.
Overflow is reported when there is insufficient room remaining in the output buffer. This condition is represented by the unique result object OVERFLOW, whose isOverflow method returns true.
A malformed-input error is reported when a sequence of input units is not well-formed. Such errors are described by instances of this class whose isMalformed method returns true and whose length method returns the length of the malformed sequence. There is one unique instance of this class for all malformed-input errors of a given length.
An unmappable-character error is reported when a sequence of input units denotes a character that cannot be represented in the output charset. Such errors are described by instances of this class whose isUnmappable method returns true and whose length method returns the length of the input sequence denoting the unmappable character. There is one unique instance of this class for all unmappable-character errors of a given length.
For convenience, the isError method returns true for result objects that describe malformed-input and unmappable-character errors but false for those that describe underflow or overflow conditions.
A description of the result state of a coder. A charset coder, that is, either a decoder or an encoder, consumes bytes (or characters) from an input buffer, translates them, and writes the resulting characters (or bytes) to an output buffer. A coding process terminates for one of four categories of reasons, which are described by instances of this class: Underflow is reported when there is no more input to be processed, or there is insufficient input and additional input is required. This condition is represented by the unique result object UNDERFLOW, whose isUnderflow method returns true. Overflow is reported when there is insufficient room remaining in the output buffer. This condition is represented by the unique result object OVERFLOW, whose isOverflow method returns true. A malformed-input error is reported when a sequence of input units is not well-formed. Such errors are described by instances of this class whose isMalformed method returns true and whose length method returns the length of the malformed sequence. There is one unique instance of this class for all malformed-input errors of a given length. An unmappable-character error is reported when a sequence of input units denotes a character that cannot be represented in the output charset. Such errors are described by instances of this class whose isUnmappable method returns true and whose length method returns the length of the input sequence denoting the unmappable character. There is one unique instance of this class for all unmappable-character errors of a given length. For convenience, the isError method returns true for result objects that describe malformed-input and unmappable-character errors but false for those that describe underflow or overflow conditions.
*-overflowclj
Static Constant.
Result object indicating overflow, meaning that there is insufficient room in the output buffer.
type: java.nio.charset.CoderResult
Static Constant. Result object indicating overflow, meaning that there is insufficient room in the output buffer. type: java.nio.charset.CoderResult
*-underflowclj
Static Constant.
Result object indicating underflow, meaning that either the input buffer has been completely consumed or, if the input buffer is not yet empty, that additional input is required.
type: java.nio.charset.CoderResult
Static Constant. Result object indicating underflow, meaning that either the input buffer has been completely consumed or, if the input buffer is not yet empty, that additional input is required. type: java.nio.charset.CoderResult
*malformed-for-lengthclj
(*malformed-for-length length)Static factory method that returns the unique object describing a malformed-input error of the given length.
length - The given length - int
returns: The requested coder-result object - java.nio.charset.CoderResult
Static factory method that returns the unique object describing a malformed-input error of the given length. length - The given length - `int` returns: The requested coder-result object - `java.nio.charset.CoderResult`
*unmappable-for-lengthclj
(*unmappable-for-length length)Static factory method that returns the unique result object describing an unmappable-character error of the given length.
length - The given length - int
returns: The requested coder-result object - java.nio.charset.CoderResult
Static factory method that returns the unique result object describing an unmappable-character error of the given length. length - The given length - `int` returns: The requested coder-result object - `java.nio.charset.CoderResult`
error?clj
(error? this)Tells whether or not this object describes an error condition.
returns: true if, and only if, this object denotes either a
malformed-input error or an unmappable-character error - boolean
Tells whether or not this object describes an error condition.
returns: true if, and only if, this object denotes either a
malformed-input error or an unmappable-character error - `boolean`lengthclj
(length this)Returns the length of the erroneous input described by this object (optional operation).
returns: The length of the erroneous input, a positive integer - int
throws: java.lang.UnsupportedOperationException - If this object does not describe an error condition, that is, if the isError does not return true
Returns the length of the erroneous input described by this object (optional operation). returns: The length of the erroneous input, a positive integer - `int` throws: java.lang.UnsupportedOperationException - If this object does not describe an error condition, that is, if the isError does not return true
malformed?clj
(malformed? this)Tells whether or not this object describes a malformed-input error.
returns: true if, and only if, this object denotes a
malformed-input error - boolean
Tells whether or not this object describes a malformed-input error.
returns: true if, and only if, this object denotes a
malformed-input error - `boolean`overflow?clj
(overflow? this)Tells whether or not this object describes an overflow condition.
returns: true if, and only if, this object denotes overflow - boolean
Tells whether or not this object describes an overflow condition. returns: true if, and only if, this object denotes overflow - `boolean`
throw-exceptionclj
(throw-exception this)Throws an exception appropriate to the result described by this object.
throws: java.nio.BufferUnderflowException - If this object is UNDERFLOW
Throws an exception appropriate to the result described by this object. throws: java.nio.BufferUnderflowException - If this object is UNDERFLOW
to-stringclj
(to-string this)Returns a string describing this coder result.
returns: A descriptive string - java.lang.String
Returns a string describing this coder result. returns: A descriptive string - `java.lang.String`
underflow?clj
(underflow? this)Tells whether or not this object describes an underflow condition.
returns: true if, and only if, this object denotes underflow - boolean
Tells whether or not this object describes an underflow condition. returns: true if, and only if, this object denotes underflow - `boolean`
unmappable?clj
(unmappable? this)Tells whether or not this object describes an unmappable-character error.
returns: true if, and only if, this object denotes an
unmappable-character error - boolean
Tells whether or not this object describes an unmappable-character
error.
returns: true if, and only if, this object denotes an
unmappable-character error - `boolean`cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close