CoderResult
open class CoderResult
kotlin.Any | |
↳ | java.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
, whoseisUnderflow
method returnstrue
. - Overflow is reported when there is insufficient room remaining in the output buffer. This condition is represented by the unique result object
OVERFLOW
, whoseisOverflow
method returnstrue
. - 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 returnstrue
and whoselength
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 returnstrue
and whoselength
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.
Summary
Public methods | |
---|---|
open Boolean |
isError() Tells whether or not this object describes an error condition. |
open Boolean |
Tells whether or not this object describes a malformed-input error. |
open Boolean |
Tells whether or not this object describes an overflow condition. |
open Boolean |
Tells whether or not this object describes an underflow condition. |
open Boolean |
Tells whether or not this object describes an unmappable-character error. |
open Int |
length() Returns the length of the erroneous input described by this object (optional operation). |
open static CoderResult! |
malformedForLength(length: Int) Static factory method that returns the unique object describing a malformed-input error of the given length. |
open Unit |
Throws an exception appropriate to the result described by this object. |
open String |
toString() Returns a string describing this coder result. |
open static CoderResult! |
unmappableForLength(length: Int) Static factory method that returns the unique result object describing an unmappable-character error of the given length. |
Properties | |
---|---|
static CoderResult! |
Result object indicating overflow, meaning that there is insufficient room in the output buffer. |
static CoderResult! |
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. |
Public methods
isError
open fun isError(): Boolean
Tells whether or not this object describes an error condition.
Return | |
---|---|
Boolean |
true if, and only if, this object denotes either a malformed-input error or an unmappable-character error |
isMalformed
open fun isMalformed(): Boolean
Tells whether or not this object describes a malformed-input error.
Return | |
---|---|
Boolean |
true if, and only if, this object denotes a malformed-input error |
isOverflow
open fun isOverflow(): Boolean
Tells whether or not this object describes an overflow condition.
Return | |
---|---|
Boolean |
true if, and only if, this object denotes overflow |
isUnderflow
open fun isUnderflow(): Boolean
Tells whether or not this object describes an underflow condition.
Return | |
---|---|
Boolean |
true if, and only if, this object denotes underflow |
isUnmappable
open fun isUnmappable(): Boolean
Tells whether or not this object describes an unmappable-character error.
Return | |
---|---|
Boolean |
true if, and only if, this object denotes an unmappable-character error |
length
open fun length(): Int
Returns the length of the erroneous input described by this object (optional operation).
Return | |
---|---|
Int |
The length of the erroneous input, a positive integer |
Exceptions | |
---|---|
java.lang.UnsupportedOperationException |
If this object does not describe an error condition, that is, if the isError does not return true |
malformedForLength
open static fun malformedForLength(length: Int): CoderResult!
Static factory method that returns the unique object describing a malformed-input error of the given length.
Parameters | |
---|---|
length |
Int: The given length |
Return | |
---|---|
CoderResult! |
The requested coder-result object |
throwException
open fun throwException(): Unit
Throws an exception appropriate to the result described by this object.
Exceptions | |
---|---|
java.nio.BufferUnderflowException |
If this object is UNDERFLOW |
java.nio.BufferOverflowException |
If this object is OVERFLOW |
java.nio.charset.MalformedInputException |
If this object represents a malformed-input error; the exception's length value will be that of this object |
java.nio.charset.UnmappableCharacterException |
If this object represents an unmappable-character error; the exceptions length value will be that of this object |
toString
open fun toString(): String
Returns a string describing this coder result.
Return | |
---|---|
String |
A descriptive string |
unmappableForLength
open static fun unmappableForLength(length: Int): CoderResult!
Static factory method that returns the unique result object describing an unmappable-character error of the given length.
Parameters | |
---|---|
length |
Int: The given length |
Return | |
---|---|
CoderResult! |
The requested coder-result object |
Properties
OVERFLOW
static val OVERFLOW: CoderResult!
Result object indicating overflow, meaning that there is insufficient room in the output buffer.
UNDERFLOW
static val UNDERFLOW: CoderResult!
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.