# CharsetDecoder

public abstract class **CharsetDecoder** extends [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)  
An engine that can transform a sequence of bytes in a specific charset into a sequence of
sixteen-bit Unicode characters.


The input byte sequence is provided in a byte buffer or a series
of such buffers. The output character sequence is written to a character buffer
or a series of such buffers. A decoder should always be used by making
the following sequence of method invocations, hereinafter referred to as a
*decoding operation*:

1. Reset the decoder via the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#reset()` method, unless it
   has not been used before;

2. Invoke the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#decode(java.nio.ByteBuffer)` method zero or more times, as
   long as additional input may be available, passing false for the
   endOfInput argument and filling the input buffer and flushing the
   output buffer between invocations;

3. Invoke the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#decode(java.nio.ByteBuffer)` method one final time, passing
   true for the endOfInput argument; and then

4. Invoke the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#flush(java.nio.CharBuffer)` method so that the decoder can
   flush any internal state to the output buffer.

Each invocation of the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#decode(java.nio.ByteBuffer)` method will decode as many bytes as possible from the input buffer, writing the resulting characters to the output buffer. The `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#decode(java.nio.ByteBuffer)` method returns when more input is required, when there is not enough room in the output buffer, or when a decoding error has occurred. In each case a `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html` object is returned to describe the reason for termination. An invoker can examine this object and fill the input buffer, flush the output buffer, or attempt to recover from a decoding error, as appropriate, and try again.

There are two general types of decoding errors. If the input byte
sequence is not legal for this charset then the input is considered *malformed*. If
the input byte sequence is legal but cannot be mapped to a valid
Unicode character then an *unmappable character* has been encountered.


How a decoding error is handled depends upon the action requested for
that type of error, which is described by an instance of the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CodingErrorAction.html` class. The possible error actions are to {@linkplain CodingErrorAction#IGNORE ignore} the erroneous input, {@linkplain CodingErrorAction#REPORT report} the error to the invoker via
the returned `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html` object, or {@linkplain CodingErrorAction#REPLACE
replace} the erroneous input with the current value of the
replacement string. The replacement


has the initial value "\\uFFFD";


its value may be changed via the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#replaceWith(java.lang.String)` method.

The default action for malformed-input and unmappable-character errors
is to {@linkplain CodingErrorAction#REPORT report} them. The
malformed-input error action may be changed via the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#onMalformedInput(java.nio.charset.CodingErrorAction)` method; the
unmappable-character action may be changed via the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#onUnmappableCharacter(java.nio.charset.CodingErrorAction)` method.

This class is designed to handle many of the details of the decoding
process, including the implementation of error actions. A decoder for a
specific charset, which is a concrete subclass of this class, need only
implement the abstract `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#decodeLoop(java.nio.ByteBuffer,%20java.nio.CharBuffer)` method, which
encapsulates the basic decoding loop. A subclass that maintains internal
state should, additionally, override the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#implFlush(java.nio.CharBuffer)` and
`https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#implReset()` methods.

Instances of this class are not safe for use by multiple concurrent
threads.

<br />

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ByteBuffer.html`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/CharBuffer.html`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/Charset.html`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetEncoder.html`

### Protected Constructor Summary

|---|---|
|   | [CharsetDecoder](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#CharsetDecoder(java.nio.charset.Charset,%20float,%20float))([Charset](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/Charset.html) cs, float averageCharsPerByte, float maxCharsPerByte) Initializes a new decoder. |

### Public Method Summary

|---|---|
| final float | [averageCharsPerByte](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#averageCharsPerByte())() Returns the average number of characters that will be produced for each byte of input. |
| final [Charset](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/Charset.html) | [charset](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#charset())() Returns the charset that created this decoder. |
| final [CharBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/CharBuffer.html) | [decode](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#decode(java.nio.ByteBuffer))([ByteBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ByteBuffer.html) in) Convenience method that decodes the remaining content of a single input byte buffer into a newly-allocated character buffer. |
| final [CoderResult](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html) | [decode](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#decode(java.nio.ByteBuffer,%20java.nio.CharBuffer,%20boolean))([ByteBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ByteBuffer.html) in, [CharBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/CharBuffer.html) out, boolean endOfInput) Decodes as many bytes as possible from the given input buffer, writing the results to the given output buffer. |
| [Charset](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/Charset.html) | [detectedCharset](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#detectedCharset())() Retrieves the charset that was detected by this decoder *(optional operation)*. |
| final [CoderResult](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html) | [flush](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#flush(java.nio.CharBuffer))([CharBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/CharBuffer.html) out) Flushes this decoder. |
| boolean | [isAutoDetecting](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#isAutoDetecting())() Tells whether or not this decoder implements an auto-detecting charset. |
| boolean | [isCharsetDetected](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#isCharsetDetected())() Tells whether or not this decoder has yet detected a charset *(optional operation)*. |
| [CodingErrorAction](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CodingErrorAction.html) | [malformedInputAction](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#malformedInputAction())() Returns this decoder's current action for malformed-input errors. |
| final float | [maxCharsPerByte](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#maxCharsPerByte())() Returns the maximum number of characters that will be produced for each byte of input. |
| final [CharsetDecoder](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html) | [onMalformedInput](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#onMalformedInput(java.nio.charset.CodingErrorAction))([CodingErrorAction](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CodingErrorAction.html) newAction) Changes this decoder's action for malformed-input errors. |
| final [CharsetDecoder](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html) | [onUnmappableCharacter](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#onUnmappableCharacter(java.nio.charset.CodingErrorAction))([CodingErrorAction](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CodingErrorAction.html) newAction) Changes this decoder's action for unmappable-character errors. |
| final [CharsetDecoder](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html) | [replaceWith](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#replaceWith(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) newReplacement) Changes this decoder's replacement value. |
| final [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [replacement](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#replacement())() Returns this decoder's replacement value. |
| final [CharsetDecoder](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html) | [reset](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#reset())() Resets this decoder, clearing any internal state. |
| [CodingErrorAction](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CodingErrorAction.html) | [unmappableCharacterAction](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#unmappableCharacterAction())() Returns this decoder's current action for unmappable-character errors. |

### Protected Method Summary

|---|---|
| abstract [CoderResult](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html) | [decodeLoop](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#decodeLoop(java.nio.ByteBuffer,%20java.nio.CharBuffer))([ByteBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ByteBuffer.html) in, [CharBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/CharBuffer.html) out) Decodes one or more bytes into one or more characters. |
| [CoderResult](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html) | [implFlush](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#implFlush(java.nio.CharBuffer))([CharBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/CharBuffer.html) out) Flushes this decoder. |
| void | [implOnMalformedInput](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#implOnMalformedInput(java.nio.charset.CodingErrorAction))([CodingErrorAction](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CodingErrorAction.html) newAction) Reports a change to this decoder's malformed-input action. |
| void | [implOnUnmappableCharacter](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#implOnUnmappableCharacter(java.nio.charset.CodingErrorAction))([CodingErrorAction](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CodingErrorAction.html) newAction) Reports a change to this decoder's unmappable-character action. |
| void | [implReplaceWith](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#implReplaceWith(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) newReplacement) Reports a change to this decoder's replacement value. |
| void | [implReset](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#implReset())() Resets this decoder, clearing any charset-specific internal state. |

### Inherited Method Summary

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

## Protected Constructors

#### protected
**CharsetDecoder**
([Charset](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/Charset.html) 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".

##### Parameters

| cs | The charset that created this decoder |
| averageCharsPerByte | A positive float value indicating the expected number of characters that will be produced for each input byte |
| maxCharsPerByte | A positive float value indicating the maximum number of characters that will be produced for each input byte |
|---|---|

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | If the preconditions on the parameters do not hold |
|---|---|

## Public Methods

#### 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.

##### Returns

- The average number of characters produced per byte of input

#### public final [Charset](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/Charset.html)
**charset**
()

Returns the charset that created this decoder.

##### Returns

- This decoder's charset

#### public final [CharBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/CharBuffer.html)
**decode**
([ByteBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ByteBuffer.html) 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](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder#steps); 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.

<br />

##### Parameters

| in | The input byte buffer |
|---|---|

##### Returns

- A newly-allocated character buffer containing the result of the decoding operation. The buffer's position will be zero and its limit will follow the last character written.

##### Throws

| [IllegalStateException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalStateException.html) | If a decoding operation is already in progress |
| [MalformedInputException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/MalformedInputException.html) | If the byte sequence starting at the input buffer's current position is not legal for this charset and the current malformed-input action is `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CodingErrorAction.html#REPORT` |
| [UnmappableCharacterException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/UnmappableCharacterException.html) | If the byte sequence starting at the input buffer's current position cannot be mapped to an equivalent character sequence and the current unmappable-character action is `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CodingErrorAction.html#REPORT` |
| [CharacterCodingException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharacterCodingException.html) |   |
|---|---|

#### public final [CoderResult](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html)
**decode**
([ByteBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ByteBuffer.html) in, [CharBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/CharBuffer.html) 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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#remaining()` bytes
will be read and at most `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html`
object to describe its reason for termination:

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html#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](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder#steps). Otherwise this method
  should be invoked again with further input.

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html#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 {@linkplain Buffer#remaining remaining} characters. This is
  typically done by draining any decoded characters from the output
  buffer.

- A {@linkplain CoderResult#malformedForLength
  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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html#length()` method. This case applies only if the
  {@linkplain #onMalformedInput malformed action} of this decoder
  is `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CodingErrorAction.html#REPORT`; otherwise the malformed input
  will be ignored or replaced, as requested.

- An {@linkplain CoderResult#unmappableForLength
  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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html#length()`
  method. This case applies only if the {@linkplain #onUnmappableCharacter
  unmappable action} of this decoder is `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CodingErrorAction.html#REPORT`; otherwise the unmappable character will be
  ignored or replaced, as requested.

In any case, if this method is to be reinvoked in the same decoding operation then care should be taken to preserve any bytes remaining in the input buffer so that they are available to the next invocation.

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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#decodeLoop(java.nio.ByteBuffer,%20java.nio.CharBuffer)`
method, interpreting its results, handling error conditions, and
reinvoking it as necessary.

<br />

##### Parameters

| in | The input byte buffer |
| out | The output character buffer |
| endOfInput | true if, and only if, the invoker can provide no additional input bytes beyond those in the given buffer |
|---|---|

##### Returns

- A coder-result object describing the reason for termination

##### Throws

| [IllegalStateException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalStateException.html) | If a decoding operation is already in progress and the previous step was an invocation neither of the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#reset()` method, nor of this method with a value of false for the endOfInput parameter, nor of this method with a value of true for the endOfInput parameter but a return value indicating an incomplete decoding operation |
| [CoderMalfunctionError](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderMalfunctionError.html) | If an invocation of the decodeLoop method threw an unexpected exception |
|---|---|

#### public [Charset](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/Charset.html)
**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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalStateException.html`.

The default implementation of this method always throws an `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/UnsupportedOperationException.html`; it should be overridden by
auto-detecting decoders to return the appropriate value.

<br />

##### Returns

- The charset detected by this auto-detecting decoder, or null if the charset has not yet been determined

##### Throws

| [IllegalStateException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalStateException.html) | If insufficient bytes have been read to determine a charset |
| [UnsupportedOperationException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/UnsupportedOperationException.html) | If this decoder does not implement an auto-detecting charset |
|---|---|

#### public final [CoderResult](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html)
**flush**
([CharBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/CharBuffer.html) 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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html#UNDERFLOW`. If there is insufficient room in the output
buffer then it returns `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html#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](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder#steps).

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

This method invokes the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#implFlush(java.nio.CharBuffer)` method to
perform the actual flushing operation.

<br />

##### Parameters

| out | The output character buffer |
|---|---|

##### Returns

- A coder-result object, either `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html#UNDERFLOW` or `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html#OVERFLOW`

##### Throws

| [IllegalStateException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalStateException.html) | If the previous step of the current decoding operation was an invocation neither of the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#flush(java.nio.CharBuffer)` method nor of the three-argument `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#decode(java.nio.ByteBuffer,%20java.nio.CharBuffer,%20boolean)` method with a value of true for the endOfInput parameter |
|---|---|

#### 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.

<br />

##### Returns

- true if, and only if, this decoder implements an auto-detecting charset

#### 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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/UnsupportedOperationException.html`; it should be overridden by
auto-detecting decoders to return true once the input charset
has been determined.

<br />

##### Returns

- true if, and only if, this decoder has detected a specific charset

##### Throws

| [UnsupportedOperationException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/UnsupportedOperationException.html) | If this decoder does not implement an auto-detecting charset |
|---|---|

#### public [CodingErrorAction](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CodingErrorAction.html)
**malformedInputAction**
()

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

##### Returns

- The current malformed-input action, which is never null

#### 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.

##### Returns

- The maximum number of characters that will be produced per byte of input

#### public final [CharsetDecoder](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html)
**onMalformedInput**
([CodingErrorAction](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CodingErrorAction.html) newAction)

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

This method invokes the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#implOnMalformedInput(java.nio.charset.CodingErrorAction)` method, passing the new action.

<br />

##### Parameters

| newAction | The new action; must not be null |
|---|---|

##### Returns

- This decoder

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | If the precondition on the parameter does not hold |
|---|---|

#### public final [CharsetDecoder](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html)
**onUnmappableCharacter**
([CodingErrorAction](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CodingErrorAction.html) newAction)

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

This method invokes the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#implOnUnmappableCharacter(java.nio.charset.CodingErrorAction)` method, passing the new action.

<br />

##### Parameters

| newAction | The new action; must not be null |
|---|---|

##### Returns

- This decoder

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | If the precondition on the parameter does not hold |
|---|---|

#### public final [CharsetDecoder](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html)
**replaceWith**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) newReplacement)

Changes this decoder's replacement value.

This method invokes the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#implReplaceWith(java.lang.String)`
method, passing the new replacement, after checking that the new
replacement is acceptable.

<br />

##### Parameters

| newReplacement | The replacement value The new replacement; must not be null and must have non-zero length |
|---|---|

##### Returns

- This decoder

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | If the preconditions on the parameter do not hold |
|---|---|

#### public final [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**replacement**
()

Returns this decoder's replacement value.

##### Returns

- This decoder's current replacement, which is never null and is never empty

#### public final [CharsetDecoder](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html)
**reset**
()

Resets this decoder, clearing any internal state.

This method resets charset-independent state and also invokes the
`https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#implReset()` method in order to perform any
charset-specific reset actions.

<br />

##### Returns

- This decoder

#### public [CodingErrorAction](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CodingErrorAction.html)
**unmappableCharacterAction**
()

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

##### Returns

- The current unmappable-character action, which is never null

## Protected Methods

#### protected abstract [CoderResult](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html)
**decodeLoop**
([ByteBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ByteBuffer.html) in, [CharBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/CharBuffer.html) 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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#decode(java.nio.ByteBuffer)` method, which handles result
interpretation and error recovery.

The buffers are read from, and written to, starting at their current
positions. At most `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#remaining()` bytes
will be read, and at most `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html` object to describe its
reason for termination, in the same manner as the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#decode(java.nio.ByteBuffer)`
method. Most implementations of this method will handle decoding errors
by returning an appropriate result object for interpretation by the
`https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html#decode(java.nio.ByteBuffer)` 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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html#UNDERFLOW` until it receives sufficient
input.

<br />

##### Parameters

| in | The input byte buffer |
| out | The output character buffer |
|---|---|

##### Returns

- A coder-result object describing the reason for termination

#### protected [CoderResult](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html)
**implFlush**
([CharBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/CharBuffer.html) out)

Flushes this decoder.

The default implementation of this method does nothing, and always
returns `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html#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.

<br />

##### Parameters

| out | The output character buffer |
|---|---|

##### Returns

- A coder-result object, either `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html#UNDERFLOW` or `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CoderResult.html#OVERFLOW`

#### protected void
**implOnMalformedInput**
([CodingErrorAction](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CodingErrorAction.html) 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.

<br />

##### Parameters

| newAction | The new action |
|---|---|

#### protected void
**implOnUnmappableCharacter**
([CodingErrorAction](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CodingErrorAction.html) 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.

<br />

##### Parameters

| newAction | The new action |
|---|---|

#### protected void
**implReplaceWith**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) 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.

<br />

##### Parameters

| newReplacement | The replacement value |
|---|---|

#### 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.

<br />