org.lightningj.util

Class ZBase32

java.lang.Object

org.lightningj.util.ZBase32

public class ZBase32
extends java.lang.Object

Z-Base32 encoder/decoder utility class, implementing the specification from http://philzimmermann.com/docs/human-oriented-base-32-encoding.txt. Z-base32 is intended to be a more human friendly encoding than base32 and is used in Lightning in for instance invoicing. This code is very much influenced by the golang version in github project tv42/zbase32. Created by Philip Vendil on 2018-02-15.

Constructor Summary

Constructors

Constructor and Description
ZBase32()

Method Summary

Modifier and Type	Method and Description
static byte[]	decode(byte[] data) Method the decode a z-base32 encoded byte[] array into into the original bytes.
static byte[]	decode(byte[] data, int numberOfBits) Method the decode a byte[] z-base32 encoded array into the original bytes when the exact number of bits is known.
static byte[]	decode(java.lang.String data) Method the decode a z-base32 encoded String into into the original bytes.
static byte[]	decode(java.lang.String data, int numberOfBits) Method the decode a byte[] z-base32 String into the original bytes when the exact number of bits is known.
static byte[]	encode(byte[] data) Method the encode a byte[] array into z-base32 encoding.
static byte[]	encode(byte[] data, int numberOfBits) Method the encode a byte[] array into z-base32 encoding when the exact number of bits is known.
static java.lang.String	encodeToString(byte[] data) Method to encode a byte[] array into a z-base32 encoded string.
static java.lang.String	encodeToString(byte[] data, int numberOfBits) Method to encode a byte[] array into a z-base32 encoded string when the exact number of bits is known.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZBase32

public ZBase32()

Method Detail

encode

public static byte[] encode(byte[] data)

Method the encode a byte[] array into z-base32 encoding.

Parameters:

data - the data to encode.

Returns:

the z-base32 encoded data.

encode

public static byte[] encode(byte[] data,
                            int numberOfBits)

Method the encode a byte[] array into z-base32 encoding when the exact number of bits is known.

Parameters:

data - the data to encode.

numberOfBits - the number of bits to use in the input data.

Returns:

the z-base32 encoded data.

encodeToString

public static java.lang.String encodeToString(byte[] data)

Method to encode a byte[] array into a z-base32 encoded string.

Parameters:

data - the data to encode.

Returns:

a z-base32 encoded string.

encodeToString

public static java.lang.String encodeToString(byte[] data,
                                              int numberOfBits)

Method to encode a byte[] array into a z-base32 encoded string when the exact number of bits is known.

Parameters:

data - the data to encode.

numberOfBits - the number of bits to use in the input data.

Returns:

a z-base32 encoded string.

decode

public static byte[] decode(byte[] data,
                            int numberOfBits)
                     throws java.lang.IllegalArgumentException

Method the decode a byte[] z-base32 encoded array into the original bytes when the exact number of bits is known.

Parameters:

data - the z-base32 data to decode.

numberOfBits - the number of bits to use in the input data.

Returns:

the original decode data.

Throws:

java.lang.IllegalArgumentException - if invalid z-base32 data was specificed.

decode

public static byte[] decode(byte[] data)
                     throws java.lang.IllegalArgumentException

Method the decode a z-base32 encoded byte[] array into into the original bytes.

Parameters:

data - the z-base32 data to decode.

Returns:

the original decode data.

Throws:

java.lang.IllegalArgumentException - if invalid z-base32 data was specificed.

decode

public static byte[] decode(java.lang.String data,
                            int numberOfBits)
                     throws java.lang.IllegalArgumentException

Method the decode a byte[] z-base32 String into the original bytes when the exact number of bits is known.

Parameters:

data - the z-base32 string to decode.

numberOfBits - the number of bits to use in the input data.

Returns:

the original decode data.

Throws:

java.lang.IllegalArgumentException - if invalid z-base32 data was specificed.

decode

public static byte[] decode(java.lang.String data)
                     throws java.lang.IllegalArgumentException

Method the decode a z-base32 encoded String into into the original bytes.

Parameters:

data - the z-base32 string to decode.

Returns:

the original decode data.

Throws:

java.lang.IllegalArgumentException - if invalid z-base32 data was specificed.