Package org.jdrupes.httpcodec.util

Class OptimizedCharsetDecoder

java.lang.Object

org.jdrupes.httpcodec.util.OptimizedCharsetDecoder

public class OptimizedCharsetDecoder
extends Object

Provides a wrapper that makes a CharsetDecoder behave like an optimized CharsetDecoder.

The default implementations of the CharsetDecoders in the JRE leave data in the input buffer if there isn't sufficient data to decode the next character. The invoker is expected to add more data to the input buffer in response to the underflow result. This processing model can be used if you have a single buffer that you fill using some source and drain using the decoder.

If you use a model where one buffer is drained by the decoder while in parallel another buffer is being filled by the source, this processing model induces some difficulties, because an unknown number of bytes would have to be copied over from the newly filled buffer to the previously decoded buffer. This class provides what the documentation of CharsetDecoder.decodeLoop(java.nio.ByteBuffer, java.nio.CharBuffer) calls an "optimized implementation". It always drains the input buffer completely, caching any bytes that cannot be decoded (yet) because they don't encode a complete character. When the decode(ByteBuffer, CharBuffer, boolean) method is invoked for the next time, as many bytes as needed to decode a complete character will be added to the cached bytes and the now available character is appended to the output. Then, the rest of the input is bulk processed as usual.

Constructor Summary

Constructors

Constructor	Description
OptimizedCharsetDecoder(CharsetDecoder backing)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
final float	averageCharsPerByte()
final Charset	charset()
final CharBuffer	decode(ByteBuffer in)
final CoderResult	decode(ByteBuffer in, CharBuffer out, boolean endOfInput)
Charset	detectedCharset()
boolean	equals(Object obj)
final CoderResult	flush(CharBuffer out)
int	hashCode()
boolean	isAutoDetecting()
boolean	isCharsetDetected()
CodingErrorAction	malformedInputAction()
final float	maxCharsPerByte()
final CharsetDecoder	onMalformedInput(CodingErrorAction newAction)
final CharsetDecoder	onUnmappableCharacter(CodingErrorAction newAction)
final String	replacement()
final CharsetDecoder	replaceWith(String newReplacement)
final CharsetDecoder	reset()
String	toString()
CodingErrorAction	unmappableCharacterAction()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OptimizedCharsetDecoder

public OptimizedCharsetDecoder(CharsetDecoder backing)

Creates a new instance.

Parameters:

backing - the backing charset decoder

Method Details

averageCharsPerByte

public final float averageCharsPerByte()

Returns:

the result

See Also:

• CharsetDecoder.averageCharsPerByte()

charset

public final Charset charset()

Returns:

the result

See Also:

• CharsetDecoder.charset()

decode

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

Parameters:

in - the data to decode

out - the decoded data

endOfInput - true if the completes the input

Returns:

the result

See Also:

• CharsetDecoder.decode(java.nio.ByteBuffer, java.nio.CharBuffer, boolean)

decode

public final CharBuffer decode(ByteBuffer in)
                        throws CharacterCodingException

Parameters:

in - the data

Returns:

the result

Throws:

CharacterCodingException - if an error occurred

See Also:

• CharsetDecoder.decode(java.nio.ByteBuffer)

detectedCharset

public Charset detectedCharset()

Returns:

the result

See Also:

• CharsetDecoder.detectedCharset()

flush

public final CoderResult flush(CharBuffer out)

Parameters:

out - the decoded data

Returns:

the result

See Also:

• CharsetDecoder.flush(java.nio.CharBuffer)

isAutoDetecting

public boolean isAutoDetecting()

Returns:

the result

See Also:

• CharsetDecoder.isAutoDetecting()

isCharsetDetected

public boolean isCharsetDetected()

Returns:

the result

See Also:

• CharsetDecoder.isCharsetDetected()

malformedInputAction

public CodingErrorAction malformedInputAction()

Returns:

the result

See Also:

• CharsetDecoder.malformedInputAction()

maxCharsPerByte

public final float maxCharsPerByte()

Returns:

the result

See Also:

• CharsetDecoder.maxCharsPerByte()

onMalformedInput

public final CharsetDecoder onMalformedInput(CodingErrorAction newAction)

Parameters:

newAction - the action

Returns:

the result

See Also:

• (java.nio.charset.CodingErrorAction)

onUnmappableCharacter

public final CharsetDecoder onUnmappableCharacter(CodingErrorAction newAction)

Parameters:

newAction - the action

Returns:

the result

See Also:

• (java.nio.charset.CodingErrorAction)

replaceWith

public final CharsetDecoder replaceWith(String newReplacement)

Parameters:

newReplacement - the replacement

Returns:

the result

See Also:

• CharsetDecoder.replaceWith(java.lang.String)

replacement

public final String replacement()

Returns:

the result

See Also:

• CharsetDecoder.replacement()

reset

public final CharsetDecoder reset()

Returns:

the result

See Also:

• CharsetDecoder.reset()

toString

public String toString()

Overrides:

toString in class Object

Returns:

the result

See Also:

• Object.toString()

unmappableCharacterAction

public CodingErrorAction unmappableCharacterAction()

Returns:

the result

See Also:

• CharsetDecoder.unmappableCharacterAction()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object