com.guardtime.ksi.util

Class BaseX

java.lang.Object

com.guardtime.ksi.util.BaseX

public class BaseX
extends Object

A generic implementation base for the RFC 4648 base-X encoders/decoders.

Constructor Summary

Constructors

Constructor and Description
BaseX(String alphabet, boolean caseSensitive, char padding) Constructs an encoder/decoder using the given characters.

Method Summary

Modifier and Type	Method and Description
byte[]	decode(String in) Decodes the given base-X string into bytes, silently ignoring any non-base-X characters.
StringBuffer	encode(byte[] in, int off, int len, String sep, int freq) Encodes the given bytes into a base-X string, optionally inserting a separator into the result with given frequency.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseX

public BaseX(String alphabet,
             boolean caseSensitive,
             char padding)

Constructs an encoder/decoder using the given characters.

Parameters:

alphabet - the encoding alphabet: the characters to use in the encoded form. The length of this string must be an exact power of 2 and the characters must be distinct.

caseSensitive - if true, both the encoder and decoder are case-sensitive; if false, the encoder always produces exactly the characters in alphabet, but decoder accepts both upper- and lower-case forms as equal.

padding - the padding character used to even out the length of the encoded output. This must not appear in the encoding alphabet.

Method Detail

encode

public final StringBuffer encode(byte[] in,
                                 int off,
                                 int len,
                                 String sep,
                                 int freq)

Encodes the given bytes into a base-X string, optionally inserting a separator into the result with given frequency.

Parameters:

in - an array containing the bytes to encode.

off - the start offset of the data within in.

len - the number of bytes to encode.

sep - if sep is not null and freq is positive, the sep is inserted into the result between blocks of freq normal characters.

freq - if sep is not null and freq is positive, the sep is inserted into the result between blocks of freq normal characters.

Returns:

A newly allocated buffer containing the encoded data.

decode

public final byte[] decode(String in)

Decodes the given base-X string into bytes, silently ignoring any non-base-X characters.

Parameters:

in - the string to decode.

Returns:

The decoded bytes.