public class Base64 extends Object
Modifier and Type | Class and Description |
---|---|
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. |
Modifier and Type | Method and Description |
---|---|
static byte[] |
decode(byte[] source)
Low-level access to decoding ASCII characters in
the form of a byte array.
|
static byte[] |
decode(String s)
Decodes data from Base64 notation, automatically
detecting gzip-compressed data and decompressing it.
|
static void |
decodeFileToFile(String infile,
String outfile)
Reads infile and decodes it to outfile.
|
static void |
decodeToFile(String dataToDecode,
String filename)
Convenience method for decoding data to a file.
|
static Object |
decodeToObject(String encodedObject)
Attempts to decode Base64 data and deserialize a Java
Object within.
|
static void |
encode(ByteBuffer raw,
ByteBuffer encoded)
Performs Base64 encoding on the
raw ByteBuffer,
writing it to the encoded ByteBuffer. |
static void |
encode(ByteBuffer raw,
CharBuffer encoded)
Performs Base64 encoding on the
raw ByteBuffer,
writing it to the encoded CharBuffer. |
static String |
encodeBytes(byte[] source)
Encodes a byte array into Base64 notation.
|
static String |
encodeBytes(byte[] source,
int options)
Encodes a byte array into Base64 notation.
|
static String |
encodeBytes(byte[] source,
int off,
int len)
Encodes a byte array into Base64 notation.
|
static byte[] |
encodeBytesToBytes(byte[] source)
Similar to
encodeBytes(byte[]) but returns
a byte array instead of instantiating a String. |
static void |
encodeFileToFile(String infile,
String outfile)
Reads infile and encodes it to outfile.
|
static String |
encodeObject(Serializable serializableObject)
Serializes an object and returns the Base64-encoded
version of that serialized object.
|
static void |
encodeToFile(byte[] dataToEncode,
String filename)
Convenience method for encoding data to a file.
|
public static void encode(ByteBuffer raw, ByteBuffer encoded)
raw
ByteBuffer,
writing it to the encoded
ByteBuffer.
This is an experimental feature. Currently it does not
pass along any options (such as DO_BREAK_LINES
or GZIP
.raw
- input bufferencoded
- output bufferpublic static void encode(ByteBuffer raw, CharBuffer encoded)
raw
ByteBuffer,
writing it to the encoded
CharBuffer.
This is an experimental feature. Currently it does not
pass along any options (such as DO_BREAK_LINES
or GZIP
.raw
- input bufferencoded
- output bufferpublic static String encodeObject(Serializable serializableObject) throws IOException
As of v 2.3, if the object cannot be serialized or there is another error, the method will throw an java.io.IOException. This is new to v2.3! In earlier versions, it just returned a null value, but in retrospect that's a pretty poor way to handle it.
The object is not GZip-compressed before being encoded.serializableObject
- The object to encodeIOException
- if there is an errorNullPointerException
- if serializedObject is nullpublic static String encodeBytes(byte[] source)
source
- The data to convertNullPointerException
- if source array is nullpublic static String encodeBytes(byte[] source, int options) throws IOException
Example options:
GZIP: gzip-compresses object before encoding it. DO_BREAK_LINES: 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.DO_BREAK_LINES )
As of v 2.3, if there is an error with the GZIP stream, the method will throw an java.io.IOException. This is new to v2.3! In earlier versions, it just returned a null value, but in retrospect that's a pretty poor way to handle it.
source
- The data to convertoptions
- Specified optionsIOException
- if there is an errorNullPointerException
- if source array is nullGZIP
,
DO_BREAK_LINES
public static String encodeBytes(byte[] source, int off, int len)
As of v 2.3, if there is an error, the method will throw an java.io.IOException. This is new to v2.3! In earlier versions, it just returned a null value, but in retrospect that's a pretty poor way to handle it.
source
- The data to convertoff
- Offset in array where conversion should beginlen
- Length of data to convertNullPointerException
- if source array is nullIllegalArgumentException
- if source array, offset, or length are invalidpublic static byte[] encodeBytesToBytes(byte[] source)
encodeBytes(byte[])
but returns
a byte array instead of instantiating a String. This is more efficient
if you're working with I/O streams and have large data sets to encode.source
- The data to convertNullPointerException
- if source array is nullpublic static byte[] decode(byte[] source) throws IOException
source
- The Base64 encoded dataIOException
public static byte[] decode(String s) throws IOException
s
- the string to decodeIOException
- If there is a problempublic static Object decodeToObject(String encodedObject) throws IOException, ClassNotFoundException
encodedObject
- The Base64 data to decodeNullPointerException
- if encodedObject is nullIOException
- if there is a general errorClassNotFoundException
- if the decoded object is of a
class that cannot be found by the JVMpublic static void encodeToFile(byte[] dataToEncode, String filename) throws IOException
As of v 2.3, if there is a error, the method will throw an java.io.IOException. This is new to v2.3! In earlier versions, it just returned false, but in retrospect that's a pretty poor way to handle it.
dataToEncode
- byte array of data to encode in base64 formfilename
- Filename for saving encoded dataIOException
- if there is an errorNullPointerException
- if dataToEncode is nullpublic static void decodeToFile(String dataToDecode, String filename) throws IOException
As of v 2.3, if there is a error, the method will throw an java.io.IOException. This is new to v2.3! In earlier versions, it just returned false, but in retrospect that's a pretty poor way to handle it.
dataToDecode
- Base64-encoded data as a stringfilename
- Filename for saving decoded dataIOException
- if there is an errorpublic static void encodeFileToFile(String infile, String outfile) throws IOException
infile
- Input fileoutfile
- Output fileIOException
- if there is an errorpublic static void decodeFileToFile(String infile, String outfile) throws IOException
infile
- Input fileoutfile
- Output fileIOException
- if there is an error