CharsetEncoder

Constructs a new CharsetEncoder using the given parameters and the replacement byte array { (byte) '?' }.

Constructs a new CharsetEncoder using the given Charset, replacement byte array, average number and maximum number of bytes created by this encoder for one input character.

Gets the average number of bytes created by this encoder for a single input character.

Checks if a given CharSequence can be encoded by this encoder. Note that this method can change the internal status of this encoder, so it should not be called when another encode process is ongoing, otherwise it will throw an IllegalStateException. This method can be overridden for performance improvement.

Checks if the given character can be encoded by this encoder.

Note that this method can change the internal status of this encoder, so it should not be called when another encoding process is ongoing, otherwise it will throw an IllegalStateException.

This method can be overridden for performance improvement.

Gets the Charset which this encoder uses.

This is a facade method for the encoding operation.

This method encodes the remaining character sequence of the given character buffer into a new byte buffer. This method performs a complete encoding operation, resets at first, then encodes, and flushes at last.

This method should not be invoked if another encode operation is ongoing.

Encodes characters starting at the current position of the given input buffer, and writes the equivalent byte sequence into the given output buffer from its current position.

The buffers' position will be changed with the reading and writing operation, but their limits and marks will be kept intact.

A CoderResult instance will be returned according to following rules:

• A malformed input result indicates that some malformed input error was encountered, and the erroneous characters start at the input buffer's position and their number can be got by result's length. This kind of result can be returned only if the malformed action is CodingErrorAction.REPORT.
• CoderResult.UNDERFLOW indicates that as many characters as possible in the input buffer have been encoded. If there is no further input and no characters left in the input buffer then this task is complete. If this is not the case then the client should call this method again supplying some more input characters.
• CoderResult.OVERFLOW indicates that the output buffer has been filled, while there are still some characters remaining in the input buffer. This method should be invoked again with a non-full output buffer.
• A unmappable character result indicates that some unmappable character error was encountered, and the erroneous characters start at the input buffer's position and their number can be got by result's length. This kind of result can be returned only on CodingErrorAction.REPORT.

The endOfInput parameter indicates if the invoker can provider further input. This parameter is true if and only if the characters in the current input buffer are all inputs for this encoding operation. Note that it is common and won't cause an error if the invoker sets false and then has no more input available, while it may cause an error if the invoker always sets true in several consecutive invocations. This would make the remaining input to be treated as malformed input. input.

This method invokes the encodeLoop method to implement the basic encode logic for a specific charset.

Flushes this encoder.

This method will call implFlush. Some encoders may need to write some bytes to the output buffer when they have read all input characters, subclasses can overridden implFlush to perform writing action.

The maximum number of written bytes won't larger than out.remaining(). If some encoder wants to write more bytes than the output buffer's available remaining space, then CoderResult.OVERFLOW will be returned, and this method must be called again with a byte buffer that has free space. Otherwise this method will return CoderResult.UNDERFLOW, which means one encoding process has been completed successfully.

During the flush, the output buffer's position will be changed accordingly, while its mark and limit will be intact.

Checks if the given argument is legal as this encoder's replacement byte array. The given byte array is legal if and only if it can be decode into sixteen bits Unicode characters. This method can be overridden for performance improvement.

Gets this encoder's CodingErrorAction when a malformed input error occurred during the encoding process.

Gets the maximum number of bytes which can be created by this encoder for one input character, must be positive.

Sets this encoder's action on malformed input error. This method will call the implOnMalformedInput method with the given new action as argument.

Sets this encoder's action on unmappable character error. This method will call the implOnUnmappableCharacter method with the given new action as argument.

Sets the new replacement value. This method first checks the given replacement's validity, then changes the replacement value and finally calls the implReplaceWith method with the given new replacement as argument.

Gets the replacement byte array, which is never null or empty.

Resets this encoder. This method will reset the internal status and then calla implReset() to reset any status related to the specific charset.

Gets this encoder's CodingErrorAction when unmappable character occurred during encoding process.

Encodes characters into bytes. This method is called by encode.

This method will implement the essential encoding operation, and it won't stop encoding until either all the input characters are read, the output buffer is filled, or some exception is encountered. Then it will return a CoderResult object indicating the result of the current encoding operation. The rule to construct the CoderResult is the same as for encode. When an exception is encountered in the encoding operation, most implementations of this method will return a relevant result object to the encode method, and some performance optimized implementation may handle the exception and implement the error action itself.

The buffers are scanned from their current positions, and their positions will be modified accordingly, while their marks and limits will be intact. At most in.remaining() characters will be read, and out.remaining() bytes will be written.

Note that some implementations may pre-scan the input buffer and return CoderResult.UNDERFLOW until it receives sufficient input.

Flushes this encoder. The default implementation does nothing and always returns CoderResult.UNDERFLOW; this method can be overridden if needed.

Notifies that this encoder's CodingErrorAction specified for malformed input error has been changed. The default implementation does nothing; this method can be overridden if needed.

Notifies that this encoder's CodingErrorAction specified for unmappable character error has been changed. The default implementation does nothing; this method can be overridden if needed.

Notifies that this encoder's replacement has been changed. The default implementation does nothing; this method can be overridden if needed.

Resets this encoder's charset related state. The default implementation does nothing; this method can be overridden if needed.