File	Doc	Category	Size	Date	Package
CoderResult.java	API Doc	Java SE 5 API	8545	Fri Aug 26 14:57:10 BST 2005	java.nio.charset

CoderResult

• java.lang.Object

Fields Summary
private static final int	CR_UNDERFLOW
private static final int	CR_OVERFLOW
private static final int	CR_ERROR_MIN
private static final int	CR_MALFORMED
private static final int	CR_UNMAPPABLE
private static final String[]	names
private final int	type
private final int	length
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.
private static Cache	malformedCache
private static Cache	unmappableCache

Constructors Summary
private CoderResult(int type, int length) this.type = type; this.length = length;

Methods Summary
public boolean	isError() Tells whether or not this object describes an error condition. return true if, and only if, this object denotes either a malformed-input error or an unmappable-character error return (type >= CR_ERROR_MIN);
public boolean	isMalformed() Tells whether or not this object describes a malformed-input error. return true if, and only if, this object denotes a malformed-input error return (type == CR_MALFORMED);
public boolean	isOverflow() Tells whether or not this object describes an overflow condition. return true if, and only if, this object denotes overflow return (type == CR_OVERFLOW);
public boolean	isUnderflow() Tells whether or not this object describes an underflow condition. return true if, and only if, this object denotes underflow return (type == CR_UNDERFLOW);
public boolean	isUnmappable() Tells whether or not this object describes an unmappable-character error. return true if, and only if, this object denotes an unmappable-character error return (type == CR_UNMAPPABLE);
public int	length() Returns the length of the erroneous input described by this object  (optional operation). return The length of the erroneous input, a positive integer throws UnsupportedOperationException If this object does not describe an error condition, that is, if the {@link #isError() isError} does not return true if (!isError()) throw new UnsupportedOperationException(); return length;
public static java.nio.charset.CoderResult	malformedForLength(int length) Static factory method that returns the unique object describing a malformed-input error of the given length. return The requested coder-result object return malformedCache.get(length);
public void	throwException() Throws an exception appropriate to the result described by this object. throws BufferUnderflowException If this object is {@link #UNDERFLOW} throws BufferOverflowException If this object is {@link #OVERFLOW} throws MalformedInputException If this object represents a malformed-input error; the exception's length value will be that of this object throws UnmappableCharacterException If this object represents an unmappable-character error; the exceptions length value will be that of this object 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 java.lang.String	toString() Returns a string describing this coder result. return A descriptive string String nm = names[type]; return isError() ? nm + "[" + length + "]" : nm;
public static java.nio.charset.CoderResult	unmappableForLength(int length) Static factory method that returns the unique result object describing an unmappable-character error of the given length. return The requested coder-result object return unmappableCache.get(length);