|
Spring for Android | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.util.support.Base64
public class Base64
Encodes and decodes to and from Base64 notation.
Homepage: http://iharder.net/base64.
Example:
String encoded = Base64.encode( myByteArray );
byte[] myByteArray = Base64.decode( encoded );
The options parameter, which appears in a few places, is used to pass several pieces of information to the encoder. In the "higher level" methods such as encodeBytes( bytes, options ) the options parameter can be used to indicate such things as first gzipping the bytes before encoding them, not inserting linefeeds, and encoding using the URL-safe and Ordered dialects.
Note, according to RFC3548, Section 2.1, implementations should not add line feeds unless explicitly told to do so. I've got Base64 set to this behavior now, although earlier versions broke lines by default.
The constants defined in Base64 can be OR-ed together to combine options, so you might make a call like this:
String encoded = Base64.encodeBytes( mybytes, Base64.GZIP | Base64.DO_BREAK_LINES );
to compress the data before encoding it and then making the output have newline characters.
Also...
String encoded = Base64.encodeBytes( crazyString.getBytes() );
Change Log:
encodeFromFile(java.lang.String)
where estimated buffer size
was wrong for files of size 31, 34, and 37 bytes.decodeToObject(java.lang.String, int, java.lang.ClassLoader)
method.encodeBytesToBytes(byte[])
family of methods (and not
using the gzip options which uses a different mechanism with streams and stuff).encodeBytesToBytes(byte[], int, int, int)
and some
similar helper methods to be more efficient with memory by not returning a
String but just a byte array.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.
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 | |
---|---|
static int |
DECODE
Specify decoding in first bit. |
static int |
DO_BREAK_LINES
Do break lines when encoding. |
static int |
DONT_GUNZIP
Specify that gzipped data should not be automatically gunzipped. |
static int |
ENCODE
Specify encoding in first bit. |
static int |
GZIP
Specify that data should be gzip-compressed in second bit. |
static int |
NO_OPTIONS
No options specified. |
static int |
ORDERED
Encode using the special "ordered" dialect of Base64 described here: http://www.faqs.org/qa/rfcc-1940.html. |
static int |
URL_SAFE
Encode using Base64-like encoding that is URL- and Filename-safe as described in Section 4 of RFC3548: http://www.faqs.org/rfcs/rfc3548.html. |
Method Summary | |
---|---|
static byte[] |
decode(byte[] source)
Low-level access to decoding ASCII characters in the form of a byte array. |
static byte[] |
decode(byte[] source,
int off,
int len,
int options)
Low-level access to decoding ASCII characters in the form of a byte array. |
static byte[] |
decode(java.lang.String s)
Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it. |
static byte[] |
decode(java.lang.String s,
int options)
Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it. |
static void |
decodeFileToFile(java.lang.String infile,
java.lang.String outfile)
Reads infile and decodes it to outfile. |
static byte[] |
decodeFromFile(java.lang.String filename)
Convenience method for reading a base64-encoded file and decoding it. |
static void |
decodeToFile(java.lang.String dataToDecode,
java.lang.String filename)
Convenience method for decoding 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.Object |
decodeToObject(java.lang.String encodedObject,
int options,
java.lang.ClassLoader loader)
Attempts to decode Base64 data and deserialize a Java Object within. |
static void |
encode(java.nio.ByteBuffer raw,
java.nio.ByteBuffer encoded)
Performs Base64 encoding on the raw ByteBuffer,
writing it to the encoded ByteBuffer. |
static void |
encode(java.nio.ByteBuffer raw,
java.nio.CharBuffer encoded)
Performs Base64 encoding on the raw ByteBuffer,
writing it to the encoded CharBuffer. |
static java.lang.String |
encodeBytes(byte[] source)
Encodes a byte array into Base64 notation. |
static java.lang.String |
encodeBytes(byte[] source,
int options)
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,
int options)
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 byte[] |
encodeBytesToBytes(byte[] source,
int off,
int len,
int options)
Similar to encodeBytes(byte[], int, int, int) but returns
a byte array instead of instantiating a String. |
static void |
encodeFileToFile(java.lang.String infile,
java.lang.String outfile)
Reads infile and encodes it to outfile. |
static java.lang.String |
encodeFromFile(java.lang.String filename)
Convenience method for reading a binary file and base64-encoding it. |
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,
int options)
Serializes an object and returns the Base64-encoded version of that serialized object. |
static void |
encodeToFile(byte[] dataToEncode,
java.lang.String filename)
Convenience method for encoding data to a file. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int NO_OPTIONS
public static final int ENCODE
public static final int DECODE
public static final int GZIP
public static final int DONT_GUNZIP
public static final int DO_BREAK_LINES
public static final int URL_SAFE
public static final int ORDERED
Method Detail |
---|
public static void encode(java.nio.ByteBuffer raw, java.nio.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(java.nio.ByteBuffer raw, java.nio.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 java.lang.String encodeObject(java.io.Serializable serializableObject) throws java.io.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 encode
java.io.IOException
- if there is an error
java.lang.NullPointerException
- if serializedObject is nullpublic static java.lang.String encodeObject(java.io.Serializable serializableObject, int options) throws java.io.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.Example options:
GZIP: gzip-compresses object before encoding it. DO_BREAK_LINES: break lines at 76 characters
Example: encodeObject( myObj, Base64.GZIP )
or
Example: encodeObject( myObj, Base64.GZIP | Base64.DO_BREAK_LINES )
serializableObject
- The object to encodeoptions
- Specified options
java.io.IOException
- if there is an errorGZIP
,
DO_BREAK_LINES
public static java.lang.String encodeBytes(byte[] source)
source
- The data to convert
java.lang.NullPointerException
- if source array is nullpublic static java.lang.String encodeBytes(byte[] source, int options) throws java.io.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 options
java.io.IOException
- if there is an error
java.lang.NullPointerException
- if source array is nullGZIP
,
DO_BREAK_LINES
public static java.lang.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 convert
java.lang.NullPointerException
- if source array is null
java.lang.IllegalArgumentException
- if source array, offset, or length are invalidpublic static java.lang.String encodeBytes(byte[] source, int off, int len, int options) throws java.io.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 convertoff
- Offset in array where conversion should beginlen
- Length of data to convertoptions
- Specified options
java.io.IOException
- if there is an error
java.lang.NullPointerException
- if source array is null
java.lang.IllegalArgumentException
- if source array, offset, or length are invalidGZIP
,
DO_BREAK_LINES
public 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 convert
java.lang.NullPointerException
- if source array is nullpublic static byte[] encodeBytesToBytes(byte[] source, int off, int len, int options) throws java.io.IOException
encodeBytes(byte[], int, int, int)
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 convertoff
- Offset in array where conversion should beginlen
- Length of data to convertoptions
- Specified options
java.io.IOException
- if there is an error
java.lang.NullPointerException
- if source array is null
java.lang.IllegalArgumentException
- if source array, offset, or length are invalidGZIP
,
DO_BREAK_LINES
public static byte[] decode(byte[] source) throws java.io.IOException
source
- The Base64 encoded data
java.io.IOException
public static byte[] decode(byte[] source, int off, int len, int options) throws java.io.IOException
source
- The Base64 encoded dataoff
- The offset of where to begin decodinglen
- The length of characters to decodeoptions
- Can specify options such as alphabet type to use
java.io.IOException
- If bogus characters exist in source datapublic static byte[] decode(java.lang.String s) throws java.io.IOException
s
- the string to decode
java.io.IOException
- If there is a problempublic static byte[] decode(java.lang.String s, int options) throws java.io.IOException
s
- the string to decodeoptions
- encode options such as URL_SAFE
java.io.IOException
- if there is an error
java.lang.NullPointerException
- if s is nullpublic static java.lang.Object decodeToObject(java.lang.String encodedObject) throws java.io.IOException, java.lang.ClassNotFoundException
encodedObject
- The Base64 data to decode
java.lang.NullPointerException
- if encodedObject is null
java.io.IOException
- if there is a general error
java.lang.ClassNotFoundException
- if the decoded object is of a
class that cannot be found by the JVMpublic static java.lang.Object decodeToObject(java.lang.String encodedObject, int options, java.lang.ClassLoader loader) throws java.io.IOException, java.lang.ClassNotFoundException
encodedObject
- The Base64 data to decodeoptions
- Various parameters related to decodingloader
- Optional class loader to use in deserializing classes.
java.lang.NullPointerException
- if encodedObject is null
java.io.IOException
- if there is a general error
java.lang.ClassNotFoundException
- if the decoded object is of a
class that cannot be found by the JVMpublic static void encodeToFile(byte[] dataToEncode, java.lang.String filename) throws java.io.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 data
java.io.IOException
- if there is an error
java.lang.NullPointerException
- if dataToEncode is nullpublic static void decodeToFile(java.lang.String dataToDecode, java.lang.String filename) throws java.io.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 data
java.io.IOException
- if there is an errorpublic static byte[] decodeFromFile(java.lang.String filename) throws java.io.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.
filename
- Filename for reading encoded data
java.io.IOException
- if there is an errorpublic static java.lang.String encodeFromFile(java.lang.String filename) throws java.io.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.
filename
- Filename for reading binary data
java.io.IOException
- if there is an errorpublic static void encodeFileToFile(java.lang.String infile, java.lang.String outfile) throws java.io.IOException
infile
- Input fileoutfile
- Output file
java.io.IOException
- if there is an errorpublic static void decodeFileToFile(java.lang.String infile, java.lang.String outfile) throws java.io.IOException
infile
- Input fileoutfile
- Output file
java.io.IOException
- if there is an error
|
Spring for Android | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |