fr.arakne.utils.encoding

Class Base64

java.lang.Object

fr.arakne.utils.encoding.Base64

public final class Base64
extends Object

Utility class for Dofus Pseudo base 64

Method Summary

Modifier and Type	Method and Description
static char	chr(@IntRange(from=0L,to=63L) int value) Get the base 64 character for the value Example: Base64.chr(3); // 'd' Base64.chr(Base64.ord('B')) == 'B';
static char	chrMod(@NonNegative int value) Get the base 64 character for the value, but after applying a modulo on the value to ensure that the call will not fail
static int	decode(String encoded) Decode pseudo base64 value to int Example: Base64.decode("c"); // 2 Base64.decode("hk"); // 458
static @PolyLength String	encode(@IntRange(from=0L,to=63L) byte[] data) Encode a byte array to Base64 string Example: Base64.encode(new byte[] {2, 31}); // "cF"
static String	encode(int value, @IntRange(from=1L,to=6L) int length) Encode an int value to pseudo base 64 Example: Base64.encode(145, 2); // "cr" Base64.encode(2, 3); // "aac"
static @IntRange(from=0L,to=63L) int	ord(char c) Get int value of base64 char Example: Base64.ord('d'); // 3 Base64.ord(Base64.chr(3)) == 3;
static byte[]	toBytes(@PolyLength String encoded) Decode a Base 64 string to a byte array Each byte will represents the ord(char) value of each characters Example: Base64.toBytes("cF"); // new byte[] {2, 31}

Methods inherited from class java.lang.Object

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

Method Detail

ord

@Pure
public static @IntRange(from=0L,to=63L) int ord(char c)

Get int value of base64 char Example: Base64.ord('d'); // 3 Base64.ord(Base64.chr(3)) == 3;

Parameters:

c - Char to convert

Returns:

The int value, between 0 and 63 included

Throws:

IllegalArgumentException - When a character outside the charset is given

See Also:

For perform the opposite operation, For decode an int string

chr

@Pure
public static char chr(@IntRange(from=0L,to=63L) int value)

Get the base 64 character for the value Example: Base64.chr(3); // 'd' Base64.chr(Base64.ord('B')) == 'B';

Parameters:

value - Value to encode. Must be in interval [0, 63]

Returns:

Encoded value

See Also:

For perform the opposite operation, For encode a 32 bits integer to a string

chrMod

@Pure
public static char chrMod(@NonNegative int value)

Get the base 64 character for the value, but after applying a modulo on the value to ensure that the call will not fail

Parameters:

value - Value to encode.

Returns:

Encoded value

encode

@SideEffectFree
public static String encode(int value,
                                            @IntRange(from=1L,to=6L) int length)

Encode an int value to pseudo base 64 Example: Base64.encode(145, 2); // "cr" Base64.encode(2, 3); // "aac"

Parameters:

value - Value to encode

length - The expected result length. Must be between 1 and 6 included

Returns:

The encoded value. The returned string length will be exactly the same as length parameter

Throws:

IllegalArgumentException - When the length parameter is invalid

encode

@SideEffectFree
public static @PolyLength String encode(@IntRange(from=0L,to=63L) byte[] data)

Encode a byte array to Base64 string Example: Base64.encode(new byte[] {2, 31}); // "cF"

Parameters:

data - Data to encode

Returns:

The encoded value. The result length is the same as the data size

See Also:

For the opposite operation

decode

@Pure
public static int decode(String encoded)

Decode pseudo base64 value to int Example: Base64.decode("c"); // 2 Base64.decode("hk"); // 458

Parameters:

encoded - The encoded value

Returns:

The decoded value

Throws:

IllegalArgumentException - When an invalid string is given

toBytes

@SideEffectFree
public static byte[] toBytes(@PolyLength String encoded)

Decode a Base 64 string to a byte array Each byte will represents the ord(char) value of each characters Example: Base64.toBytes("cF"); // new byte[] {2, 31}

Parameters:

encoded - The encoded string

Returns:

The decode byte array. The array size will be the same as the string length