com.screenscraper.util

Class Base64

java.lang.Object

com.screenscraper.util.Base64

public class Base64
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Base64.InputStream A Base64.InputStream will read data from another 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 OutputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	COMPRESS Specify that data should be compressed (value is true).
static boolean	DECODE Specify decoding (value is false).
static boolean	DONT_COMPRESS Specify that data should not be compressed (value is false).
static boolean	ENCODE Specify encoding (value is true).

Method Summary

Modifier and Type	Method and Description
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.
static byte[]	decodeFromFile(java.lang.String encfile) Simple helper method that Base64-decodes a file and returns the decoded data or null if there was an error.
static boolean	decodeToFile(byte[] encdata, java.lang.String file) Simple helper method that Base64-decodes data to a file.
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.
static java.lang.String	encodeBytes(byte[] source) Encodes a byte array into Base64 notation.
static java.lang.String	encodeBytes(byte[] source, boolean breakLines) 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	encodeBytes(byte[] source, int off, int len, boolean breakLines) Encodes a byte array into Base64 notation.
static java.lang.String	encodeFromFile(java.lang.String rawfile) Simple helper method that Base64-encodes a file and returns the encoded string or null if there was an error.
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	encodeObject(java.io.Serializable serializableObject, boolean breakLines) 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 java.lang.String	encodeString(java.lang.String s, boolean breakLines) Encodes a string in Base64 notation with line breaks after every 75 Base64 characters.
static boolean	encodeToFile(byte[] rawdata, java.lang.String file) Simple helper method that Base64-encodes data to a file.
static void	main(java.lang.String[] args) Testing.
static byte[]	readFile(java.io.File file, boolean encode) Reads a file and either encodes or decodes it.
static byte[]	readFile(java.lang.String file, boolean encode) Reads a file and either encodes or decodes it.
static boolean	writeFile(byte[] data, java.io.File file, boolean encode) Writes a byte array to a file either encoding it or decoding it as specified.
static boolean	writeFile(byte[] data, int offset, int length, java.io.File file, boolean encode) Writes a byte array to a file either encoding it or decoding it as specified.
static boolean	writeFile(byte[] data, java.lang.String file, boolean encode) Writes a byte array to a file either encoding it or decoding it as specified.

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

COMPRESS

public static final boolean COMPRESS

Specify that data should be compressed (value is true).

See Also:

Constant Field Values

DONT_COMPRESS

public static final boolean DONT_COMPRESS

Specify that data should not be compressed (value is false).

See Also:

Constant Field Values

Method Detail

main

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

Testing. Feel free--in fact I encourage you--to throw out this entire "main" method when you actually deploy this code.

Parameters:

args - The command line arguments

encodeObject

@Nullable
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.

Parameters:

serializableObject - The object to encode

Returns:

The Base64-encoded object

Since:

1.4

encodeObject

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

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.

Parameters:

serializableObject - The object to encode

breakLines - Break lines at 80 characters or less.

Returns:

The Base64-encoded object

Since:

1.4

encodeBytes

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

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

Parameters:

source - The data to convert

Returns:

The string representing the encoded bytes

Since:

1.4

encodeBytes

public static java.lang.String encodeBytes(@NotNull
                                           byte[] source,
                                           boolean breakLines)

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

Parameters:

source - The data to convert

breakLines - Break lines at 80 characters or less.

Returns:

The encoded byte string

Since:

1.4

encodeBytes

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

Encodes a byte array into Base64 notation.

Parameters:

source - The data to convert

off - Offset in array where conversion should begin

len - Length of data to convert

Returns:

The encoded bytes as a string

Since:

1.4

encodeBytes

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

Encodes a byte array into Base64 notation.

Parameters:

source - The data to convert

off - Offset in array where conversion should begin

len - Length of data to convert

breakLines - Break lines at 80 characters or less.

Returns:

The encoded bytes as a string

Since:

1.4

encodeString

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

Encodes a string in Base64 notation with line breaks after every 75 Base64 characters. Of course you probably only need to encode a string if there are non-ASCII characters in it such as many non-English languages.

Parameters:

s - the string to encode

Returns:

the encoded string

Since:

1.3

encodeString

public static java.lang.String encodeString(@NotNull
                                            java.lang.String s,
                                            boolean breakLines)

Encodes a string in Base64 notation with line breaks after every 75 Base64 characters. Of course you probably only need to encode a string if there are non-ASCII characters in it such as many non-English languages.

Parameters:

s - the string to encode

breakLines - Break lines at 80 characters or less.

Returns:

the encoded string

Since:

1.3

readFile

@Nullable
public static byte[] readFile(@NotNull
                                         java.lang.String file,
                                         boolean encode)

Reads a file and either encodes or decodes it.

Parameters:

file - The file to read

encode - Whether or not to encode file as it is read.

Returns:

The encoded/decoded file or null if there was an error.

Since:

1.4

readFile

@Nullable
public static byte[] readFile(@NotNull
                                         java.io.File file,
                                         boolean encode)

Reads a file and either encodes or decodes it.

Parameters:

file - The file to read

encode - Whether or not to encode file as it is read.

Returns:

The encoded/decoded file or null if there was an error.

Since:

1.4

writeFile

public static boolean writeFile(@NotNull
                                byte[] data,
                                @NotNull
                                java.lang.String file,
                                boolean encode)

Writes a byte array to a file either encoding it or decoding it as specified.

Parameters:

data - The array to write to a file.

file - The file to write to.

encode - Whether or not to encode the data.

Returns:

Whether or not the write was a success.

Since:

1.4

writeFile

public static boolean writeFile(@NotNull
                                byte[] data,
                                @NotNull
                                java.io.File file,
                                boolean encode)

Writes a byte array to a file either encoding it or decoding it as specified.

Parameters:

data - The array to write to a file.

file - The file to write to.

encode - Whether or not to encode the data.

Returns:

Whether or not the write was a success.

Since:

1.4

writeFile

public static boolean writeFile(@NotNull
                                byte[] data,
                                int offset,
                                int length,
                                @NotNull
                                java.io.File file,
                                boolean encode)

Writes a byte array to a file either encoding it or decoding it as specified.

Parameters:

data - The array to write to a file.

offset - The offset where the "real" data begins.

length - The amount of data to write.

file - The file to write to.

encode - Whether or not to encode the data.

Returns:

Whether or not the write was a success.

Since:

1.4

encodeFromFile

public static java.lang.String encodeFromFile(@NotNull
                                              java.lang.String rawfile)

Simple helper method that Base64-encodes a file and returns the encoded string or null if there was an error.

Parameters:

rawfile - The file to read

Returns:

The encoded file or null if there was an error.

Since:

1.4

decodeFromFile

@Nullable
public static byte[] decodeFromFile(@NotNull
                                               java.lang.String encfile)

Simple helper method that Base64-decodes a file and returns the decoded data or null if there was an error.

Parameters:

encfile - The file to read

Returns:

The decoded file or null if there was an error.

Since:

1.4

encodeToFile

public static boolean encodeToFile(@NotNull
                                   byte[] rawdata,
                                   @NotNull
                                   java.lang.String file)

Simple helper method that Base64-encodes data to a file.

Parameters:

rawdata - The data to write.

file - The file to read.

Returns:

Whether or not the write was a success.

Since:

1.4

decodeToFile

public static boolean decodeToFile(@NotNull
                                   byte[] encdata,
                                   @NotNull
                                   java.lang.String file)

Simple helper method that Base64-decodes data to a file.

Parameters:

encdata - The data to write.

file - The file to read.

Returns:

Whether or not the write was a success.

Since:

1.4

decode

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

Decodes data from Base64 notation.

Parameters:

s - the string to decode

Returns:

the decoded data

Since:

1.4

decodeToString

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

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

Parameters:

s - the strind to decode

Returns:

The data as a string

Since:

1.4

decodeToObject

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

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

Parameters:

encodedObject - The Base64 data to decode

Returns:

The decoded and deserialized object

Since:

1.4

decode

public static byte[] decode(byte[] source,
                            int off,
                            int len)

Decodes Base64 content in byte array format and returns the decoded byte array.

Parameters:

source - The Base64 encoded data

off - The offset of where to begin decoding

len - The length of characters to decode

Returns:

decoded data

Since:

1.3