org.sw4j.tool.barcode.random.encoder

Class ByteArrayEncoder

java.lang.Object

org.sw4j.tool.barcode.random.encoder.ByteArrayEncoder

Direct Known Subclasses:

Base58Encoder, Base64Encoder, HexEncoder

public abstract class ByteArrayEncoder
extends Object

This class is an interface for new Encoders (e.g. Base58Encoder) and a factory for such encoders.

Author:

Uwe Plonus <u.plonus@gmail.com>

Constructor Summary

Constructors

Constructor and Description
ByteArrayEncoder()

Method Summary

Modifier and Type	Method and Description
abstract String	encode(byte[] data) Encode the given byte array data into the encoding that is supported by the encoder.
static ByteArrayEncoder	forEncoding(String encoding) Return an encoder for the given encoding (e.g.
abstract boolean	supports(String encoding) For concrete encoders this method should return true if the given encoding is supported.

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteArrayEncoder

public ByteArrayEncoder()

Method Detail

supports

public abstract boolean supports(String encoding)

For concrete encoders this method should return true if the given encoding is supported.

Parameters:

encoding - the encoding to check for.

Returns:

true if the encoding is supported by the encoder.

encode

public abstract String encode(byte[] data)

Encode the given byte array data into the encoding that is supported by the encoder.

Parameters:

data - the data to encode.

Returns:

the encoded data.

forEncoding

public static ByteArrayEncoder forEncoding(String encoding)

Return an encoder for the given encoding (e.g. base58).

Parameters:

encoding - the encoding for which an encoder should be created.

Returns:

the encoder for the encoding or null if no encoder is available.