java.nio.charset: public class: CoderResult

java.nio.charset
public class: CoderResult [javadoc | source]

java.lang.Object
   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 , 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.

author: Mark - Reinhold

author: JSR-51 - Expert Group

since: 1.4 -

Field Summary
public static final 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.
public static final CoderResult	OVERFLOW	Result object indicating overflow, meaning that there is insufficient room in the output buffer.

Method from java.nio.charset.CoderResult Summary:
isError, isMalformed, isOverflow, isUnderflow, isUnmappable, length, malformedForLength, throwException, toString, unmappableForLength

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from java.nio.charset.CoderResult Detail:
public boolean isError() { return (type >= CR_ERROR_MIN); } Tells whether or not this object describes an error condition.
public boolean isMalformed() { return (type == CR_MALFORMED); } Tells whether or not this object describes a malformed-input error.
public boolean isOverflow() { return (type == CR_OVERFLOW); } Tells whether or not this object describes an overflow condition.
public boolean isUnderflow() { return (type == CR_UNDERFLOW); } Tells whether or not this object describes an underflow condition.
public boolean isUnmappable() { return (type == CR_UNMAPPABLE); } Tells whether or not this object describes an unmappable-character error.
public int length() { if (!isError()) throw new UnsupportedOperationException(); return length; } Returns the length of the erroneous input described by this object (optional operation).
public static CoderResult malformedForLength(int length) { return malformedCache.get(length); } Static factory method that returns the unique object describing a malformed-input error of the given length.
public void throwException() throws CharacterCodingException { switch (type) { case CR_UNDERFLOW: throw new BufferUnderflowException(); case CR_OVERFLOW: throw new BufferOverflowException(); case CR_MALFORMED: throw new MalformedInputException(length); case CR_UNMAPPABLE: throw new UnmappableCharacterException(length); default: assert false; } } Throws an exception appropriate to the result described by this object.
public String toString() { String nm = names[type]; return isError() ? nm + "[" + length + "]" : nm; } Returns a string describing this coder result.
public static CoderResult unmappableForLength(int length) { return unmappableCache.get(length); } Static factory method that returns the unique result object describing an unmappable-character error of the given length.

Method from java.nio.charset.CoderResult Detail:

 public boolean isError() {
        return (type  >= CR_ERROR_MIN);
}

 public boolean isMalformed() {
        return (type == CR_MALFORMED);
}

 public boolean isOverflow() {
        return (type == CR_OVERFLOW);
}

 public boolean isUnderflow() {
        return (type == CR_UNDERFLOW);
}

 public boolean isUnmappable() {
        return (type == CR_UNMAPPABLE);
}

 public int length() {
        if (!isError())
            throw new UnsupportedOperationException();
        return length;
}

(optional operation)

 public static CoderResult malformedForLength(int length) {
                                 
        return malformedCache.get(length);
}

 public  void throwException() throws CharacterCodingException {
        switch (type) {
        case CR_UNDERFLOW:   throw new BufferUnderflowException();
        case CR_OVERFLOW:    throw new BufferOverflowException();
        case CR_MALFORMED:   throw new MalformedInputException(length);
        case CR_UNMAPPABLE:  throw new UnmappableCharacterException(length);
        default:
            assert false;
        }
}

 public String toString() {
        String nm = names[type];
        return isError() ? nm + "[" + length + "]" : nm;
}

Returns a string describing this coder result.

 public static CoderResult unmappableForLength(int length) {
                                  
        return unmappableCache.get(length);
}