| java.lang.Object
 com.rift.coad.lib.thirdparty.base64.Base64
| Base64 | | public class Base64 (Code) | | |
| Field Summary | |
| final public static int | DECODE
Specify decoding. | | final public static int | DONT_BREAK_LINES
| | final public static int | ENCODE
Specify encoding. | | final public static int | GZIP
Specify that data should be gzip-compressed. | | final public static int | NO_OPTIONS
No options specified. |
| Method Summary | |
| public static byte[] | decode(byte[] source, int off, int len)
Very low-level access to decoding ASCII characters in
the form of a byte array. | | public static byte[] | decode(String s)
Decodes data from Base64 notation, automatically
detecting gzip-compressed data and decompressing it. | | public static byte[] | decodeFromFile(String filename)
Convenience method for reading a base64-encoded
file and decoding it. | | public static boolean | decodeToFile(String dataToDecode, String filename)
Convenience method for decoding data to a file. | | public static Object | decodeToObject(String encodedObject)
Attempts to decode Base64 data and deserialize a Java
Object within. | | public static String | encodeBytes(byte[] source)
Encodes a byte array into Base64 notation. | | public static String | encodeBytes(byte[] source, int options)
Encodes a byte array into Base64 notation. | | public static String | encodeBytes(byte[] source, int off, int len)
Encodes a byte array into Base64 notation. | | public static String | encodeBytes(byte[] source, int off, int len, int options)
Encodes a byte array into Base64 notation. | | public static String | encodeFromFile(String filename)
Convenience method for reading a binary file
and base64-encoding it. | | public static String | encodeObject(java.io.Serializable serializableObject)
Serializes an object and returns the Base64-encoded
version of that serialized object. | | public static String | encodeObject(java.io.Serializable serializableObject, int options)
Serializes an object and returns the Base64-encoded
version of that serialized object. | | public static boolean | encodeToFile(byte[] dataToEncode, String filename)
Convenience method for encoding data to a file. |
| DECODE | | final public static int DECODE(Code) | | Specify decoding.
|
| DONT_BREAK_LINES | | final public static int DONT_BREAK_LINES(Code) | | Don't break lines when encoding (violates strict Base64 specification)
|
| ENCODE | | final public static int ENCODE(Code) | | Specify encoding.
|
| GZIP | | final public static int GZIP(Code) | | Specify that data should be gzip-compressed.
|
| NO_OPTIONS | | final public static int NO_OPTIONS(Code) | | No options specified. Value is zero.
|
| decode | | public static byte[] decode(byte[] source, int off, int len)(Code) | | Very low-level access to decoding ASCII characters in
the form of a byte array. Does not support automatically
gunzipping or any other "fancy" features.
Parameters:
source - The Base64 encoded data
Parameters:
off - The offset of where to begin decoding
Parameters:
len - The length of characters to decode decoded data
since:
1.3 |
| decode | | public static byte[] decode(String s)(Code) | | Decodes data from Base64 notation, automatically
detecting gzip-compressed data and decompressing it.
Parameters:
s - the string to decode the decoded data
since:
1.4 |
| decodeFromFile | | public static byte[] decodeFromFile(String filename)(Code) | | Convenience method for reading a base64-encoded
file and decoding it.
Parameters:
filename - Filename for reading encoded data decoded byte array or null if unsuccessful
since:
2.1 |
| decodeToFile | | public static boolean decodeToFile(String dataToDecode, String filename)(Code) | | Convenience method for decoding data to a file.
Parameters:
dataToDecode - Base64-encoded data as a string
Parameters:
filename - Filename for saving decoded data true if successful, false otherwise
since:
2.1 |
| decodeToObject | | public static Object decodeToObject(String encodedObject)(Code) | | 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 The decoded and deserialized object
since:
1.5 |
| encodeBytes | | public static String encodeBytes(byte[] source)(Code) | | Encodes a byte array into Base64 notation.
Does not GZip-compress data.
Parameters:
source - The data to convert
since:
1.4 |
| encodeBytes | | public static String encodeBytes(byte[] source, int options)(Code) | | Encodes a byte array into Base64 notation.
Valid options:
GZIP: gzip-compresses object before encoding it.
DONT_BREAK_LINES: don't break lines at 76 characters
Note: Technically, this makes your encoding non-compliant.
Example: encodeBytes( myData, Base64.GZIP ) or
Example: encodeBytes( myData, Base64.GZIP | Base64.DONT_BREAK_LINES )
Parameters:
source - The data to convert
Parameters:
options - Specified options
See Also: Base64.GZIP
See Also: Base64.DONT_BREAK_LINES
since:
2.0 |
| encodeBytes | | public static String encodeBytes(byte[] source, int off, int len)(Code) | | Encodes a byte array into Base64 notation.
Does not GZip-compress data.
Parameters:
source - The data to convert
Parameters:
off - Offset in array where conversion should begin
Parameters:
len - Length of data to convert
since:
1.4 |
| encodeBytes | | public static String encodeBytes(byte[] source, int off, int len, int options)(Code) | | Encodes a byte array into Base64 notation.
Valid options:
GZIP: gzip-compresses object before encoding it.
DONT_BREAK_LINES: don't break lines at 76 characters
Note: Technically, this makes your encoding non-compliant.
Example: encodeBytes( myData, Base64.GZIP ) or
Example: encodeBytes( myData, Base64.GZIP | Base64.DONT_BREAK_LINES )
Parameters:
source - The data to convert
Parameters:
off - Offset in array where conversion should begin
Parameters:
len - Length of data to convert
Parameters:
options - Specified options
See Also: Base64.GZIP
See Also: Base64.DONT_BREAK_LINES
since:
2.0 |
| encodeFromFile | | public static String encodeFromFile(String filename)(Code) | | Convenience method for reading a binary file
and base64-encoding it.
Parameters:
filename - Filename for reading binary data base64-encoded string or null if unsuccessful
since:
2.1 |
| encodeObject | | public static String encodeObject(java.io.Serializable serializableObject)(Code) | | 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.
The object is not GZip-compressed before being encoded.
Parameters:
serializableObject - The object to encode The Base64-encoded object
since:
1.4 |
| encodeObject | | public static String encodeObject(java.io.Serializable serializableObject, int options)(Code) | | 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.
Valid options:
GZIP: gzip-compresses object before encoding it.
DONT_BREAK_LINES: don't break lines at 76 characters
Note: Technically, this makes your encoding non-compliant.
Example: encodeObject( myObj, Base64.GZIP ) or
Example: encodeObject( myObj, Base64.GZIP | Base64.DONT_BREAK_LINES )
Parameters:
serializableObject - The object to encode
Parameters:
options - Specified options The Base64-encoded object
See Also: Base64.GZIP
See Also: Base64.DONT_BREAK_LINES
since:
2.0 |
| encodeToFile | | public static boolean encodeToFile(byte[] dataToEncode, String filename)(Code) | | Convenience method for encoding data to a file.
Parameters:
dataToEncode - byte array of data to encode in base64 form
Parameters:
filename - Filename for saving encoded data true if successful, false otherwise
since:
2.1 |
|
|