net.lecousin.framework.io.text

Class Decoder

java.lang.Object

net.lecousin.framework.io.text.Decoder

All Implemented Interfaces:

Closeable, AutoCloseable, AsyncCloseable<IOException>

Direct Known Subclasses:

DefaultDecoder, UTF8Decoder

public abstract class Decoder
extends Object
implements Closeable, AsyncCloseable<IOException>

Charset decoder.

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteBuffer	currentBuffer
protected IO.Readable.Buffered	io
protected AsyncSupplier<ByteBuffer,IOException>	nextBuffer

Constructor Summary

Constructors

Constructor and Description
Decoder()

Method Summary

Modifier and Type	Method and Description
IAsync<IOException>	canDecode() When the decode method returns -2, this method can be used to know when new data is available to be decoded.
void	close()
IAsync<IOException>	closeAsync() Close asynchronously.
int	decode(ByteBuffer b, char[] chars, int pos, int len) Decode characters without IO.
protected abstract int	decode(ByteBuffer b, char[] chars, int pos, int len, MutableBoolean interrupt, int min)
int	decode(char[] chars, int pos, int len, MutableBoolean interrupt, int min) Decode characters from the IO.
static Decoder	get(Charset charset) Get a decoder for the given charset.
abstract Charset	getEncoding() Return the charset of this decoder.
static void	register(Charset charset, Class<? extends Decoder> decoder) Register a decoder implementation.
void	setFirstBytes(byte[] bytes) Set first bytes to decode before the IO.
void	setFirstBytes(ByteBuffer bytes) Set first bytes to decode before the IO.
void	setInput(IO.Readable.Buffered io) Set readable IO to decode.
void	transferTo(Decoder newDecoder) Change charset by transfering the current state of this decoder to the new one.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.lecousin.framework.util.AsyncCloseable

closeAfter

Field Detail

io

protected IO.Readable.Buffered io

nextBuffer

protected AsyncSupplier<ByteBuffer,IOException> nextBuffer

currentBuffer

protected ByteBuffer currentBuffer

Constructor Detail

Decoder

public Decoder()

Method Detail

get

public static Decoder get(Charset charset)
                   throws InstantiationException,
                          IllegalAccessException

Get a decoder for the given charset.

Throws:

InstantiationException

IllegalAccessException

register

public static void register(Charset charset,
                            Class<? extends Decoder> decoder)

Register a decoder implementation.

setFirstBytes

public void setFirstBytes(byte[] bytes)

Set first bytes to decode before the IO.

setFirstBytes

public void setFirstBytes(ByteBuffer bytes)

Set first bytes to decode before the IO.

setInput

public void setInput(IO.Readable.Buffered io)

Set readable IO to decode.

transferTo

public void transferTo(Decoder newDecoder)

Change charset by transfering the current state of this decoder to the new one.

canDecode

public IAsync<IOException> canDecode()

When the decode method returns -2, this method can be used to know when new data is available to be decoded.

decode

public int decode(char[] chars,
                  int pos,
                  int len,
                  MutableBoolean interrupt,
                  int min)
           throws IOException,
                  CancelException

Decode characters from the IO.

Parameters:

chars - array to fill

pos - offset in the array to fill

len - maximum number of characters to fill

interrupt - when true, the decoding will stop as soon as possible

min - minimum number of characters to fill, regardless of the interrupt value

Returns:

number of decoded characters, -1 if no more characters can be decoded, -2 if we need to wait for next buffer from the IO

Throws:

IOException - error reading from IO

CancelException - IO has been cancelled

decode

public int decode(ByteBuffer b,
                  char[] chars,
                  int pos,
                  int len)

Decode characters without IO.

decode

protected abstract int decode(ByteBuffer b,
                              char[] chars,
                              int pos,
                              int len,
                              MutableBoolean interrupt,
                              int min)

getEncoding

public abstract Charset getEncoding()

Return the charset of this decoder.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

closeAsync

public IAsync<IOException> closeAsync()

Description copied from interface: AsyncCloseable

Close asynchronously.

Specified by:

closeAsync in interface AsyncCloseable<IOException>