com.dyuproject.protostuff

Class B64Code

java.lang.Object

com.dyuproject.protostuff.B64Code

public final class B64Code
extends java.lang.Object

Fast B64 Encoder/Decoder as described in RFC 1421.

Does not insert or interpret whitespace as described in RFC 1521. If you require this you must pre/post process your data.

Note that in a web context the usual case is to not want linebreaks or other white space in the encoded output. All methods that begin with 'c' will use char arrays (as output on encode, as input on decode).

Author:

Brett Sealey (bretts), Greg Wilkins (gregw), David Yu (dyu)

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	code2nibble
static byte[]	code2nibbleUrlSafe
static byte[]	nibble2code
static byte[]	nibble2codeUrlSafe
static byte	pad
static byte	padUrlSafe

Method Summary

Methods

Modifier and Type	Method and Description
static byte[]	cdecode(char[] b) Fast Base 64 decode as described in RFC 1421.
static byte[]	cdecode(char[] input, int inOffset, int inLen)
static byte[]	cdecode(char[] input, int inOffset, int inLen, byte[] code2nibble, byte pad) Fast Base 64 decode as described in RFC 1421.
static byte[]	cdecodeUS(char[] input, int inOffset, int inLen)
static char[]	cencode(byte[] input) Fast Base 64 encode as described in RFC 1421.
static char[]	cencode(byte[] input, int inOffset, int inLen) Fast Base 64 encode as described in RFC 1421.
static char[]	cencodeUS(byte[] input, int inOffset, int inLen) Fast Base 64 encode as described in RFC 1421.
static byte[]	decode(byte[] b) Fast Base 64 decode as described in RFC 1421.
static byte[]	decode(byte[] input, int inOffset, int inLen)
static byte[]	decode(byte[] input, int inOffset, int inLen, byte[] code2nibble, byte pad) Fast Base 64 decode as described in RFC 1421.
static byte[]	decode(java.lang.String str) Returns the base 64 decoded bytes.
static byte[]	decode(java.lang.String str, int inOffset, int inLen)
static byte[]	decode(java.lang.String str, int inOffset, int inLen, byte[] code2nibble, byte pad) Returns the base 64 decoded bytes.
static int	decodeTo(byte[] output, int outOffset, byte[] input, int inOffset, int inLen, byte[] code2nibble, byte pad) Returns the length of the decoded base64 input (written to the provided output byte array).
static int	decodeTo(byte[] output, int outOffset, java.lang.String str, int inOffset, int inLen, byte[] code2nibble, byte pad) Returns the length of the decoded base64 input (written to the provided output byte array).
static byte[]	decodeUS(byte[] input, int inOffset, int inLen)
static byte[]	decodeUS(java.lang.String str, int inOffset, int inLen)
static byte[]	encode(byte[] input) Fast Base 64 encode as described in RFC 1421.
static byte[]	encode(byte[] input, int inOffset, int inLen) Fast Base 64 encode as described in RFC 1421.
static LinkedBuffer	encode(byte[] input, int inOffset, int inLen, byte[] nibble2code, byte pad, WriteSession session, LinkedBuffer lb) Encodes the byte array into the LinkedBuffer and grows when full.
static LinkedBuffer	encode(byte[] input, int inOffset, int inLen, WriteSession session, LinkedBuffer lb) Encodes the byte array into the LinkedBuffer and grows when full.
static byte[]	encodeUS(byte[] input, int inOffset, int inLen) Fast Base 64 encode as described in RFC 1421.
static LinkedBuffer	sencode(byte[] input, int inOffset, int inLen, byte[] nibble2code, byte pad, WriteSession session, LinkedBuffer lb) Encodes the byte array into the LinkedBuffer and flushes to the OutputStream when buffer is full.
static LinkedBuffer	sencode(byte[] input, int inOffset, int inLen, WriteSession session, LinkedBuffer lb) Encodes the byte array into the LinkedBuffer and flushes to the OutputStream when buffer is full.

Methods inherited from class java.lang.Object

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

Field Detail

pad

public static final byte pad

See Also:

Constant Field Values

padUrlSafe

public static final byte padUrlSafe

See Also:

Constant Field Values

nibble2code

public static final byte[] nibble2code

nibble2codeUrlSafe

public static final byte[] nibble2codeUrlSafe

code2nibble

public static final byte[] code2nibble

code2nibbleUrlSafe

public static final byte[] code2nibbleUrlSafe

Method Detail

encode

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

Fast Base 64 encode as described in RFC 1421.

encode

public static byte[] encode(byte[] input,
            int inOffset,
            int inLen)

Fast Base 64 encode as described in RFC 1421.

encodeUS

public static byte[] encodeUS(byte[] input,
              int inOffset,
              int inLen)

Fast Base 64 encode as described in RFC 1421.

cencode

public static char[] cencode(byte[] input)

Fast Base 64 encode as described in RFC 1421.

cencode

public static char[] cencode(byte[] input,
             int inOffset,
             int inLen)

Fast Base 64 encode as described in RFC 1421.

cencodeUS

public static char[] cencodeUS(byte[] input,
               int inOffset,
               int inLen)

Fast Base 64 encode as described in RFC 1421.

encode

public static LinkedBuffer encode(byte[] input,
                  int inOffset,
                  int inLen,
                  WriteSession session,
                  LinkedBuffer lb)
                           throws java.io.IOException

Encodes the byte array into the LinkedBuffer and grows when full.

Throws:

java.io.IOException

encode

public static LinkedBuffer encode(byte[] input,
                  int inOffset,
                  int inLen,
                  byte[] nibble2code,
                  byte pad,
                  WriteSession session,
                  LinkedBuffer lb)
                           throws java.io.IOException

Encodes the byte array into the LinkedBuffer and grows when full.

Throws:

java.io.IOException

sencode

public static LinkedBuffer sencode(byte[] input,
                   int inOffset,
                   int inLen,
                   WriteSession session,
                   LinkedBuffer lb)
                            throws java.io.IOException

Encodes the byte array into the LinkedBuffer and flushes to the OutputStream when buffer is full.

Throws:

java.io.IOException

sencode

public static LinkedBuffer sencode(byte[] input,
                   int inOffset,
                   int inLen,
                   byte[] nibble2code,
                   byte pad,
                   WriteSession session,
                   LinkedBuffer lb)
                            throws java.io.IOException

Encodes the byte array into the LinkedBuffer and flushes to the OutputStream when buffer is full.

Throws:

java.io.IOException

decode

public static byte[] decode(byte[] b)

Fast Base 64 decode as described in RFC 1421.

cdecode

public static byte[] cdecode(char[] b)

Fast Base 64 decode as described in RFC 1421.

decode

public static byte[] decode(byte[] input,
            int inOffset,
            int inLen)

decodeUS

public static byte[] decodeUS(byte[] input,
              int inOffset,
              int inLen)

decode

public static byte[] decode(byte[] input,
            int inOffset,
            int inLen,
            byte[] code2nibble,
            byte pad)

Fast Base 64 decode as described in RFC 1421.

Does not attempt to cope with extra whitespace as described in RFC 1521.

Avoids creating extra copies of the input/output.

Note this code has been flattened for performance.

Parameters:

input - byte array to decode.

inOffset - the offset.

inLen - the length.

Returns:

byte array containing the decoded form of the input.

Throws:

java.lang.IllegalArgumentException - if the input is not a valid B64 encoding.

cdecode

public static byte[] cdecode(char[] input,
             int inOffset,
             int inLen)

cdecodeUS

public static byte[] cdecodeUS(char[] input,
               int inOffset,
               int inLen)

cdecode

public static byte[] cdecode(char[] input,
             int inOffset,
             int inLen,
             byte[] code2nibble,
             byte pad)

Fast Base 64 decode as described in RFC 1421.

Does not attempt to cope with extra whitespace as described in RFC 1521.

Avoids creating extra copies of the input/output.

Note this code has been flattened for performance.

Parameters:

input - char array to decode.

inOffset - the offset.

inLen - the length.

Returns:

byte array containing the decoded form of the input.

Throws:

java.lang.IllegalArgumentException - if the input is not a valid B64 encoding.

decodeTo

public static int decodeTo(byte[] output,
           int outOffset,
           byte[] input,
           int inOffset,
           int inLen,
           byte[] code2nibble,
           byte pad)

Returns the length of the decoded base64 input (written to the provided output byte array). The output byte array must have enough capacity or it will fail.

decode

public static byte[] decode(java.lang.String str)

Returns the base 64 decoded bytes. The provided str must already be base-64 encoded.

decode

public static byte[] decode(java.lang.String str,
            int inOffset,
            int inLen)

decodeUS

public static byte[] decodeUS(java.lang.String str,
              int inOffset,
              int inLen)

decode

public static byte[] decode(java.lang.String str,
            int inOffset,
            int inLen,
            byte[] code2nibble,
            byte pad)

Returns the base 64 decoded bytes. The provided str must already be base-64 encoded.

decodeTo

public static int decodeTo(byte[] output,
           int outOffset,
           java.lang.String str,
           int inOffset,
           int inLen,
           byte[] code2nibble,
           byte pad)

Returns the length of the decoded base64 input (written to the provided output byte array). The output byte array must have enough capacity or it will fail.