net.sf.kdgcommons.codec

Class Codec

java.lang.Object

net.sf.kdgcommons.codec.Codec

Direct Known Subclasses:

Base64Codec, HexCodec

public abstract class Codec
extends Object

Implementations translate an input stream to an output stream according to specific rules. As a convenience, instances also provide a conversion between byte arrays, and may provide conversions to/from strings.

Callers should not make any assumptions about stream buffering, and must close the streams (if appropriate) after encoding/decoding.

Any method may throw CodecException.

Instances are thread-safe and reentrant.

Since:

1.0.14

Field Summary

Fields

Modifier and Type	Field and Description
protected static byte[]	EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
Codec()

Method Summary

Modifier and Type	Method and Description
byte[]	decode(byte[] src) Convenience method that decodes the passed array.
byte[]	decode(byte[] src, int off, int len) Convenience method that decodes a section of the passed array.
abstract void	decode(InputStream in, OutputStream out) Decodes a stream according to the rules of the codec.
byte[]	encode(byte[] src) Convenience method that encodes the passed array.
byte[]	encode(byte[] src, int off, int len) Convenience method that encodes a section of the passed array.
abstract void	encode(InputStream in, OutputStream out) Encodes a stream according to the rules of the codec.
protected static int	nextNonWhitespace(InputStream in) Returns the next non-whitespace character from the input stream, -1 if at EOF.
protected static void	skipIfSeparator(InputStream in, byte[] separator) Checks the content of the stream against the separator, and skips the separator if they match.
protected static InputStream	wrapIfNeeded(InputStream in, byte[] separator) Optionally wraps the passed input stream to allow backtracking with the passed separator.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY

protected static final byte[] EMPTY_ARRAY

Constructor Detail

Codec

public Codec()

Method Detail

encode

public abstract void encode(InputStream in,
                            OutputStream out)

Encodes a stream according to the rules of the codec.

decode

public abstract void decode(InputStream in,
                            OutputStream out)

Decodes a stream according to the rules of the codec.

Throws:

IllegalArgumentException - if the input stream is not encoded correctly.

encode

public byte[] encode(byte[] src)

Convenience method that encodes the passed array.

encode

public byte[] encode(byte[] src,
                     int off,
                     int len)

Convenience method that encodes a section of the passed array.

decode

public byte[] decode(byte[] src)

Convenience method that decodes the passed array.

decode

public byte[] decode(byte[] src,
                     int off,
                     int len)

Convenience method that decodes a section of the passed array. The caller is responsible for ensuring that the specified section is actually valid encoded data.

wrapIfNeeded

protected static InputStream wrapIfNeeded(InputStream in,
                                          byte[] separator)

Optionally wraps the passed input stream to allow backtracking with the passed separator.

skipIfSeparator

protected static void skipIfSeparator(InputStream in,
                                      byte[] separator)
                               throws IOException

Checks the content of the stream against the separator, and skips the separator if they match. Note: requires a wrapped stream.

Throws:

IOException

nextNonWhitespace

protected static int nextNonWhitespace(InputStream in)
                                throws IOException

Returns the next non-whitespace character from the input stream, -1 if at EOF.

Throws:

IOException