Base64

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> dbunit >> [ util overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.dbunit.util
Class Base64

java.lang.Object
  org.dbunit.util.Base64

public class Base64
extends java.lang.Object

I am placing this code in the Public Domain. Do with it as you will. This software comes with no guarantees or warranties but with plenty of well-wishing instead! Please visit http://iharder.net/base64 periodically to check for updates or to contribute improvements.

Version:: 1.3

Nested Class Summary

static class Base64.InputStream
          A Base64#InputStream will read data from another java.io.InputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.

static class Base64.OutputStream
          A Base64#OutputStream will write data to another java.io.OutputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.

Field Summary

private static byte[] ALPHABET
          The 64 valid Base64 values.

private static byte BAD_ENCODING


private static byte[] DECODABET
          Translates a Base64 value to either its 6-bit reconstruction value or a negative number indicating some other meaning.

static boolean DECODE
          Specify decoding (value is false).

static boolean ENCODE
          Specify encoding (value is true).

private static byte EQUALS_SIGN
          The equals sign (=) as a byte.

private static byte EQUALS_SIGN_ENC


private static int MAX_LINE_LENGTH
          Maximum line length (76) of Base64 output.

private static byte NEW_LINE
          The new line character (\n) as a byte.

private static byte WHITE_SPACE_ENC


Constructor Summary

private Base64()
          Defeats instantiation.

Method Summary

static byte[] decode(byte[] source, int off, int len)
          Decodes Base64 content in byte array format and returns the decoded byte array.

static byte[] decode(java.lang.String s)
          Decodes data from Base64 notation.

private static byte[] decode4to3(byte[] fourBytes)
          Decodes the first four bytes of array fourBytes and returns an array up to three bytes long with the decoded values.

private static int decode4to3(byte[] source, int srcOffset, byte[] destination, int destOffset)
          Decodes four bytes from array source and writes the resulting bytes (up to three of them) to destination.

static java.lang.Object decodeToObject(java.lang.String encodedObject)
          Attempts to decode Base64 data and deserialize a Java Object within.

static java.lang.String decodeToString(java.lang.String s)
          Decodes data from Base64 notation and returns it as a string.

private static byte[] encode3to4(byte[] threeBytes)
          Encodes the first three bytes of array threeBytes and returns a four-byte array in Base64 notation.

private static byte[] encode3to4(byte[] threeBytes, int numSigBytes)
          Encodes up to the first three bytes of array threeBytes and returns a four-byte array in Base64 notation.

private static byte[] encode3to4(byte[] source, int srcOffset, int numSigBytes, byte[] destination, int destOffset)
          Encodes up to three bytes of the array source and writes the resulting four Base64 bytes to destination.

static java.lang.String encodeBytes(byte[] source)
          Encodes a byte array into Base64 notation.

static java.lang.String encodeBytes(byte[] source, int off, int len)
          Encodes a byte array into Base64 notation.

static java.lang.String encodeObject(java.io.Serializable serializableObject)
          Serializes an object and returns the Base64-encoded version of that serialized object.

static java.lang.String encodeString(java.lang.String s)
          Encodes a string in Base64 notation with line breaks after every 75 Base64 characters.

static void main(java.lang.String[] args)
          Testing.

Methods inherited from class java.lang.Object

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

Field Detail

ENCODE

public static final boolean ENCODE

Specify encoding (value is true).

See Also:: Constant Field Values

DECODE

public static final boolean DECODE

Specify decoding (value is false).

See Also:: Constant Field Values

MAX_LINE_LENGTH

private static final int MAX_LINE_LENGTH

Maximum line length (76) of Base64 output.

See Also:: Constant Field Values

EQUALS_SIGN

private static final byte EQUALS_SIGN

The equals sign (=) as a byte.

See Also:: Constant Field Values

NEW_LINE

private static final byte NEW_LINE

The new line character (\n) as a byte.

See Also:: Constant Field Values

ALPHABET

private static final byte[] ALPHABET

The 64 valid Base64 values.

DECODABET

private static final byte[] DECODABET

Translates a Base64 value to either its 6-bit reconstruction value or a negative number indicating some other meaning.

BAD_ENCODING

private static final byte BAD_ENCODING

See Also:: Constant Field Values

WHITE_SPACE_ENC

private static final byte WHITE_SPACE_ENC

See Also:: Constant Field Values

EQUALS_SIGN_ENC

private static final byte EQUALS_SIGN_ENC

See Also:: Constant Field Values

Constructor Detail

Base64

private Base64()

Defeats instantiation.

Method Detail

main

public static void main(java.lang.String[] args)

Testing.

encode3to4

private static byte[] encode3to4(byte[] threeBytes)

Encodes the first three bytes of array threeBytes and returns a four-byte array in Base64 notation.

Since:: 1.3

encode3to4

private static byte[] encode3to4(byte[] threeBytes,
                                 int numSigBytes)

Encodes up to the first three bytes of array threeBytes and returns a four-byte array in Base64 notation. The actual number of significant bytes in your array is given by numSigBytes. The array threeBytes needs only be as big as numSigBytes.

Since:: 1.3

encode3to4

private static byte[] encode3to4(byte[] source,
                                 int srcOffset,
                                 int numSigBytes,
                                 byte[] destination,
                                 int destOffset)

Encodes up to three bytes of the array source and writes the resulting four Base64 bytes to destination. The source and destination arrays can be manipulated anywhere along their length by specifying srcOffset and destOffset. This method does not check to make sure your arrays are large enough to accomodate srcOffset + 3 for the source array or destOffset + 4 for the destination array. The actual number of significant bytes in your array is given by numSigBytes.

Since:: 1.3

encodeObject

public static java.lang.String encodeObject(java.io.Serializable serializableObject)

Serializes an object and returns the Base64-encoded version of that serialized object. If the object cannot be serialized or there is another error, the method will return null.

Since:: 1.4

encodeBytes

public static java.lang.String encodeBytes(byte[] source)

Encodes a byte array into Base64 notation. Equivalen to calling encodeBytes( source, 0, source.length )

Since:: 1.4

encodeBytes

public static java.lang.String encodeBytes(byte[] source,
                                           int off,
                                           int len)

Encodes a byte array into Base64 notation.

Since:: 1.4

encodeString

public static java.lang.String encodeString(java.lang.String s)

Encodes a string in Base64 notation with line breaks after every 75 Base64 characters.

Since:: 1.3

decode4to3

private static byte[] decode4to3(byte[] fourBytes)

Decodes the first four bytes of array fourBytes and returns an array up to three bytes long with the decoded values.

Since:: 1.3

decode4to3

private static int decode4to3(byte[] source,
                              int srcOffset,
                              byte[] destination,
                              int destOffset)

Decodes four bytes from array source and writes the resulting bytes (up to three of them) to destination. The source and destination arrays can be manipulated anywhere along their length by specifying srcOffset and destOffset. This method does not check to make sure your arrays are large enough to accomodate srcOffset + 4 for the source array or destOffset + 3 for the destination array. This method returns the actual number of bytes that were converted from the Base64 encoding.

Since:: 1.3

decode

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

Decodes data from Base64 notation.

Since:: 1.4

decodeToString

public static java.lang.String decodeToString(java.lang.String s)

Decodes data from Base64 notation and returns it as a string. Equivlaent to calling new String( decode( s ) )

Since:: 1.4

decodeToObject

public static java.lang.Object decodeToObject(java.lang.String encodedObject)

Attempts to decode Base64 data and deserialize a Java Object within. Returns null if there was an error.

Since:: 1.4

Nested Class Summary
`static class`	`Base64.InputStream` A `Base64#InputStream` will read data from another java.io.InputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.
`static class`	`Base64.OutputStream` A `Base64#OutputStream` will write data to another java.io.OutputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.

Field Summary
`private static byte[]`	`ALPHABET` The 64 valid Base64 values.
`private static byte`	`BAD_ENCODING`
`private static byte[]`	`DECODABET` Translates a Base64 value to either its 6-bit reconstruction value or a negative number indicating some other meaning.
`static boolean`	`DECODE` Specify decoding (value is `false`).
`static boolean`	`ENCODE` Specify encoding (value is `true`).
`private static byte`	`EQUALS_SIGN` The equals sign (=) as a byte.
`private static byte`	`EQUALS_SIGN_ENC`
`private static int`	`MAX_LINE_LENGTH` Maximum line length (76) of Base64 output.
`private static byte`	`NEW_LINE` The new line character (\n) as a byte.
`private static byte`	`WHITE_SPACE_ENC`

Constructor Summary
`private`	`Base64()` Defeats instantiation.

Method Summary
`static byte[]`	`decode(byte[] source, int off, int len)` Decodes Base64 content in byte array format and returns the decoded byte array.
`static byte[]`	`decode(java.lang.String s)` Decodes data from Base64 notation.
`private static byte[]`	`decode4to3(byte[] fourBytes)` Decodes the first four bytes of array `fourBytes` and returns an array up to three bytes long with the decoded values.
`private static int`	`decode4to3(byte[] source, int srcOffset, byte[] destination, int destOffset)` Decodes four bytes from array `source` and writes the resulting bytes (up to three of them) to `destination`.
`static java.lang.Object`	`decodeToObject(java.lang.String encodedObject)` Attempts to decode Base64 data and deserialize a Java Object within.
`static java.lang.String`	`decodeToString(java.lang.String s)` Decodes data from Base64 notation and returns it as a string.
`private static byte[]`	`encode3to4(byte[] threeBytes)` Encodes the first three bytes of array `threeBytes` and returns a four-byte array in Base64 notation.
`private static byte[]`	`encode3to4(byte[] threeBytes, int numSigBytes)` Encodes up to the first three bytes of array `threeBytes` and returns a four-byte array in Base64 notation.
`private static byte[]`	`encode3to4(byte[] source, int srcOffset, int numSigBytes, byte[] destination, int destOffset)` Encodes up to three bytes of the array `source` and writes the resulting four Base64 bytes to `destination`.
`static java.lang.String`	`encodeBytes(byte[] source)` Encodes a byte array into Base64 notation.
`static java.lang.String`	`encodeBytes(byte[] source, int off, int len)` Encodes a byte array into Base64 notation.
`static java.lang.String`	`encodeObject(java.io.Serializable serializableObject)` Serializes an object and returns the Base64-encoded version of that serialized object.
`static java.lang.String`	`encodeString(java.lang.String s)` Encodes a string in Base64 notation with line breaks after every 75 Base64 characters.
`static void`	`main(java.lang.String[] args)` Testing.

org.dbunit.util Class Base64

ENCODE

DECODE

MAX_LINE_LENGTH

EQUALS_SIGN

NEW_LINE

ALPHABET

DECODABET

BAD_ENCODING

WHITE_SPACE_ENC

EQUALS_SIGN_ENC

Base64

main

encode3to4

encode3to4

encode3to4

encodeObject

encodeBytes

encodeBytes

encodeString

decode4to3

decode4to3

decode

decodeToString

decodeToObject

decode

org.dbunit.util
Class Base64