| |
|
| java.lang.Object
 java.nio.charset.CoderResult
| CoderResult | | public class CoderResult (Code) | | 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
CoderResult.UNDERFLOW , whose
CoderResult.isUnderflow() 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
CoderResult.OVERFLOW , whose
CoderResult.isOverflow()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
CoderResult.isMalformed() isMalformed method returns
true and whose
CoderResult.length() 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
CoderResult.isUnmappable() isUnmappable method returns true and
whose
CoderResult.length() 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
CoderResult.isError() 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.
author:
Mark Reinhold
author:
JSR-51 Expert Group
version:
1.15, 07/05/05
since:
1.4 |
| Field Summary | |
| final public static CoderResult | OVERFLOW
Result object indicating overflow, meaning that there is insufficient
room in the output buffer. | | final public static CoderResult | UNDERFLOW
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. |
| Method Summary | |
| public boolean | isError()
Tells whether or not this object describes an error condition. | | public boolean | isMalformed()
Tells whether or not this object describes a malformed-input error. | | public boolean | isOverflow()
Tells whether or not this object describes an overflow condition. | | public boolean | isUnderflow()
Tells whether or not this object describes an underflow condition. | | public boolean | isUnmappable()
Tells whether or not this object describes an unmappable-character
error. | | public int | length()
Returns the length of the erroneous input described by this
object (optional operation). | | public static CoderResult | malformedForLength(int length)
Static factory method that returns the unique object describing a
malformed-input error of the given length. | | public void | throwException()
Throws an exception appropriate to the result described by this object. | | public String | toString()
Returns a string describing this coder result. | | public static CoderResult | unmappableForLength(int length)
Static factory method that returns the unique result object describing
an unmappable-character error of the given length. |
| OVERFLOW | | final public static CoderResult OVERFLOW(Code) | | Result object indicating overflow, meaning that there is insufficient
room in the output buffer.
|
| UNDERFLOW | | final public static CoderResult UNDERFLOW(Code) | | 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.
|
| isError | | public boolean isError()(Code) | | Tells whether or not this object describes an error condition.
true if, and only if, this object denotes either amalformed-input error or an unmappable-character error |
| isMalformed | | public boolean isMalformed()(Code) | | Tells whether or not this object describes a malformed-input error.
true if, and only if, this object denotes amalformed-input error |
| isOverflow | | public boolean isOverflow()(Code) | | Tells whether or not this object describes an overflow condition.
true if, and only if, this object denotes overflow |
| isUnderflow | | public boolean isUnderflow()(Code) | | Tells whether or not this object describes an underflow condition.
true if, and only if, this object denotes underflow |
| isUnmappable | | public boolean isUnmappable()(Code) | | Tells whether or not this object describes an unmappable-character
error.
true if, and only if, this object denotes anunmappable-character error |
| length | | public int length()(Code) | | Returns the length of the erroneous input described by this
object (optional operation).
The length of the erroneous input, a positive integer
throws:
UnsupportedOperationException - If this object does not describe an error condition, that is,if the CoderResult.isError() isError does not return true |
| malformedForLength | | public static CoderResult malformedForLength(int length)(Code) | | Static factory method that returns the unique object describing a
malformed-input error of the given length.
The requested coder-result object |
| throwException | | public void throwException() throws CharacterCodingException(Code) | | Throws an exception appropriate to the result described by this object.
throws:
BufferUnderflowException - If this object is CoderResult.UNDERFLOW
throws:
BufferOverflowException - If this object is CoderResult.OVERFLOW
throws:
MalformedInputException - If this object represents a malformed-input error; theexception's length value will be that of this object
throws:
UnmappableCharacterException - If this object represents an unmappable-character error; theexceptions length value will be that of this object |
| toString | | public String toString()(Code) | | Returns a string describing this coder result.
A descriptive string |
| unmappableForLength | | public static CoderResult unmappableForLength(int length)(Code) | | Static factory method that returns the unique result object describing
an unmappable-character error of the given length.
The requested coder-result object |
|
|
|