CharsetDecoder

See also:

• ByteBuffer
• CharBuffer
• Charset
• CharsetEncoder

CharsetDecoder

protected CharsetDecoder (Charset cs, 
                float averageCharsPerByte, 
                float maxCharsPerByte)

Initializes a new decoder. The new decoder will have the given chars-per-byte values and its replacement will be the string "\uFFFD".

averageCharsPerByte

public final float averageCharsPerByte ()

Returns the average number of characters that will be produced for each byte of input. This heuristic value may be used to estimate the size of the output buffer required for a given input sequence.

charset

public final Charset charset ()

Returns the charset that created this decoder.

decode

public final CharBuffer decode (ByteBuffer in)

Convenience method that decodes the remaining content of a single input byte buffer into a newly-allocated character buffer.

This method implements an entire decoding operation; that is, it resets this decoder, then it decodes the bytes in the given byte buffer, and finally it flushes this decoder. This method should therefore not be invoked if a decoding operation is already in progress.

decode

public final CoderResult decode (ByteBuffer in, 
                CharBuffer out, 
                boolean endOfInput)

Decodes as many bytes as possible from the given input buffer, writing the results to the given output buffer.

The buffers are read from, and written to, starting at their current positions. At most in.remaining() bytes will be read and at most out.remaining() characters will be written. The buffers' positions will be advanced to reflect the bytes read and the characters written, but their marks and limits will not be modified.

In addition to reading bytes from the input buffer and writing characters to the output buffer, this method returns a CoderResult object to describe its reason for termination:

• CoderResult#UNDERFLOW indicates that as much of the input buffer as possible has been decoded. If there is no further input then the invoker can proceed to the next step of the decoding operation. Otherwise this method should be invoked again with further input.

• CoderResult#OVERFLOW indicates that there is insufficient space in the output buffer to decode any more bytes. This method should be invoked again with an output buffer that has more remaining characters. This is typically done by draining any decoded characters from the output buffer.

• A malformed-input result indicates that a malformed-input error has been detected. The malformed bytes begin at the input buffer's (possibly incremented) position; the number of malformed bytes may be determined by invoking the result object's length method. This case applies only if the malformed action of this decoder is CodingErrorAction#REPORT; otherwise the malformed input will be ignored or replaced, as requested.

• An unmappable-character result indicates that an unmappable-character error has been detected. The bytes that decode the unmappable character begin at the input buffer's (possibly incremented) position; the number of such bytes may be determined by invoking the result object's length method. This case applies only if the unmappable action of this decoder is CodingErrorAction.REPORT; otherwise the unmappable character will be ignored or replaced, as requested.

The endOfInput parameter advises this method as to whether the invoker can provide further input beyond that contained in the given input buffer. If there is a possibility of providing additional input then the invoker should pass false for this parameter; if there is no possibility of providing further input then the invoker should pass true. It is not erroneous, and in fact it is quite common, to pass false in one invocation and later discover that no further input was actually available. It is critical, however, that the final invocation of this method in a sequence of invocations always pass true so that any remaining undecoded input will be treated as being malformed.

This method works by invoking the decodeLoop method, interpreting its results, handling error conditions, and reinvoking it as necessary.

detectedCharset

public Charset detectedCharset ()

Retrieves the charset that was detected by this decoder  (optional operation).

If this decoder implements an auto-detecting charset then this method returns the actual charset once it has been detected. After that point, this method returns the same value for the duration of the current decoding operation. If not enough input bytes have yet been read to determine the actual charset then this method throws an IllegalStateException.

The default implementation of this method always throws an UnsupportedOperationException; it should be overridden by auto-detecting decoders to return the appropriate value.

flush

public final CoderResult flush (CharBuffer out)

Flushes this decoder.

Some decoders maintain internal state and may need to write some final characters to the output buffer once the overall input sequence has been read.

Any additional output is written to the output buffer beginning at its current position. At most out.remaining() characters will be written. The buffer's position will be advanced appropriately, but its mark and limit will not be modified.

If this method completes successfully then it returns CoderResult.UNDERFLOW. If there is insufficient room in the output buffer then it returns CoderResult#OVERFLOW. If this happens then this method must be invoked again, with an output buffer that has more room, in order to complete the current decoding operation.

If this decoder has already been flushed then invoking this method has no effect.

This method invokes the implFlush method to perform the actual flushing operation.

isAutoDetecting

public boolean isAutoDetecting ()

Tells whether or not this decoder implements an auto-detecting charset.

The default implementation of this method always returns false; it should be overridden by auto-detecting decoders to return true.

isCharsetDetected

public boolean isCharsetDetected ()

Tells whether or not this decoder has yet detected a charset  (optional operation).

If this decoder implements an auto-detecting charset then at a single point during a decoding operation this method may start returning true to indicate that a specific charset has been detected in the input byte sequence. Once this occurs, the detectedCharset method may be invoked to retrieve the detected charset.

That this method returns false does not imply that no bytes have yet been decoded. Some auto-detecting decoders are capable of decoding some, or even all, of an input byte sequence without fixing on a particular charset.

The default implementation of this method always throws an UnsupportedOperationException; it should be overridden by auto-detecting decoders to return true once the input charset has been determined.

malformedInputAction

public CodingErrorAction malformedInputAction ()

Returns this decoder's current action for malformed-input errors.

maxCharsPerByte

public final float maxCharsPerByte ()

Returns the maximum number of characters that will be produced for each byte of input. This value may be used to compute the worst-case size of the output buffer required for a given input sequence. This value accounts for any necessary content-independent prefix or suffix characters.

onMalformedInput

public final CharsetDecoder onMalformedInput (CodingErrorAction newAction)

Changes this decoder's action for malformed-input errors.

This method invokes the implOnMalformedInput method, passing the new action.

onUnmappableCharacter

public final CharsetDecoder onUnmappableCharacter (CodingErrorAction newAction)

Changes this decoder's action for unmappable-character errors.

This method invokes the implOnUnmappableCharacter method, passing the new action.

replaceWith

public final CharsetDecoder replaceWith (String newReplacement)

Changes this decoder's replacement value.

This method invokes the implReplaceWith method, passing the new replacement, after checking that the new replacement is acceptable.

replacement

public final String replacement ()

Returns this decoder's replacement value.

reset

public final CharsetDecoder reset ()

Resets this decoder, clearing any internal state.

This method resets charset-independent state and also invokes the implReset method in order to perform any charset-specific reset actions.

unmappableCharacterAction

public CodingErrorAction unmappableCharacterAction ()

Returns this decoder's current action for unmappable-character errors.

decodeLoop

protected abstract CoderResult decodeLoop (ByteBuffer in, 
                CharBuffer out)

Decodes one or more bytes into one or more characters.

This method encapsulates the basic decoding loop, decoding as many bytes as possible until it either runs out of input, runs out of room in the output buffer, or encounters a decoding error. This method is invoked by the decode method, which handles result interpretation and error recovery.

The buffers are read from, and written to, starting at their current positions. At most in.remaining() bytes will be read, and at most out.remaining() characters will be written. The buffers' positions will be advanced to reflect the bytes read and the characters written, but their marks and limits will not be modified.

This method returns a CoderResult object to describe its reason for termination, in the same manner as the decode method. Most implementations of this method will handle decoding errors by returning an appropriate result object for interpretation by the decode method. An optimized implementation may instead examine the relevant error action and implement that action itself.

An implementation of this method may perform arbitrary lookahead by returning CoderResult#UNDERFLOW until it receives sufficient input.

implFlush

protected CoderResult implFlush (CharBuffer out)

Flushes this decoder.

The default implementation of this method does nothing, and always returns CoderResult#UNDERFLOW. This method should be overridden by decoders that may need to write final characters to the output buffer once the entire input sequence has been read.

implOnMalformedInput

protected void implOnMalformedInput (CodingErrorAction newAction)

Reports a change to this decoder's malformed-input action.

The default implementation of this method does nothing. This method should be overridden by decoders that require notification of changes to the malformed-input action.

implOnUnmappableCharacter

protected void implOnUnmappableCharacter (CodingErrorAction newAction)

Reports a change to this decoder's unmappable-character action.

The default implementation of this method does nothing. This method should be overridden by decoders that require notification of changes to the unmappable-character action.

implReplaceWith

protected void implReplaceWith (String newReplacement)

Reports a change to this decoder's replacement value.

The default implementation of this method does nothing. This method should be overridden by decoders that require notification of changes to the replacement.

implReset

protected void implReset ()

Resets this decoder, clearing any charset-specific internal state.

The default implementation of this method does nothing. This method should be overridden by decoders that maintain internal state.