java.nio.charset.CoderResult
Used to indicate the result of encoding/decoding. There are four types of
results:
- UNDERFLOW indicates all input has been processed, or more input is
required. It is represented by the unique object
CoderResult.UNDERFLOW
.
- OVERFLOW indicates insufficient output buffer. It is represented by the
unique object
CoderResult.OVERFLOW
.
- A malformed-input error indicates an unrecognizable sequence of input
units has been encountered. Get an instance of this type of result by calling
CoderResult.malformedForLength(int)
with the length of the
malformed-input.
- An unmappable-character error indicates a sequence of input units can
not be mapped to the output charset. Get an instance of this type of result
by calling
CoderResult.unmappableForLength(int)
with the input
sequence size indicating the identity of the unmappable character.
Summary
Constants
|
|
|
Value |
|
CoderResult |
OVERFLOW |
Result object used to signify that the out buffer does not have enough
space available in it to store the result of the encoding/decoding. |
|
|
CoderResult |
UNDERFLOW |
Result object indicating that there is insufficient data in the
encoding/decoding buffer or that additional data is required. |
|
|
Public Methods
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
Details
Constants
public
static
final
CoderResult
OVERFLOW
Result object used to signify that the out buffer does not have enough
space available in it to store the result of the encoding/decoding.
public
static
final
CoderResult
UNDERFLOW
Result object indicating that there is insufficient data in the
encoding/decoding buffer or that additional data is required.
Public Methods
public
boolean
isError()
Returns true if this result represents a malformed-input error or an
unmappable-character error.
Returns
- true if a malformed-input error or an unmappable-character error,
otherwise false
public
boolean
isMalformed()
Returns true if this result represents a malformed-input error.
Returns
- true if a malformed-input error, otherwise false
public
boolean
isOverflow()
Returns true if this result is an overflow condition.
Returns
- true if an overflow, otherwise false
public
boolean
isUnderflow()
Returns true if this result is an underflow condition.
Returns
- true if an underflow, otherwise false
public
boolean
isUnmappable()
Returns true if this result represents an unmappable-character error.
Returns
- true if an unmappable-character error, otherwise false
public
int
length()
Gets the length of the erroneous input. The length is only meaningful to
a malformed-input error or an unmappble character error.
Returns
- the length, as an integer, of this object's erroneous input
public
static
synchronized
CoderResult
malformedForLength(int length)
Gets a
CoderResult
object indicating a malformed-input
error.
Parameters
length
| the length of the malformed-input |
Returns
- a
CoderResult
object indicating a malformed-input
error
public
void
throwException()
Throws an exception corresponding to this coder result.
public
String
toString()
Returns a text description of this result.
Returns
- a text description of this result
public
static
synchronized
CoderResult
unmappableForLength(int length)
Gets a
CoderResult
object indicating an unmappable
character error.
Parameters
length
| the length of the input unit sequence denoting the unmappable
character |
Returns
- a
CoderResult
object indicating an unmappable
character error