public final class Base64 extends Object
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. |
Modifier and Type | Field and Description |
---|---|
static int |
DECODE
Specify decoding.
|
static int |
DONT_BREAK_LINES
Don't break lines when encoding (violates strict Base64 specification)
|
static int |
ENCODE
Specify encoding.
|
static int |
GZIP
Specify that data should be gzip-compressed.
|
static int |
NO_OPTIONS
No options specified.
|
static String |
PREFERRED_ENCODING
Preferred encoding.
|
Modifier and Type | Method and Description |
---|---|
static byte[] |
decode(byte[] source,
int off,
int len)
Very low-level access to decoding ASCII characters in the form of a byte
array.
|
static byte[] |
decode(String encodedValue)
Decodes the given
s . |
static byte[] |
decodeFromFile(String filename)
Convenience method for reading a base64-encoded file and decoding it.
|
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 byte[] |
decodeWithoutUnzipping(String encodedValue)
Similar to
decode(String) only that it will not check
the decoded value for GZip compression and thus will not
decompress anything |
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 String |
encodeBytes(byte[] source,
int off,
int len,
int options)
Encodes a byte array into Base64 notation.
|
static String |
encodeFromFile(String filename)
Convenience method for reading a binary file and base64-encoding it.
|
static String |
encodeObject(Serializable serializableObject)
Serializes an object and returns the Base64-encoded version of that serialized
object.
|
static String |
encodeObject(Serializable serializableObject,
int options)
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 final int NO_OPTIONS
public static final int ENCODE
public static final int DECODE
public static final int GZIP
public static final int DONT_BREAK_LINES
public static final String PREFERRED_ENCODING
public static String encodeObject(Serializable serializableObject) throws IOException
serializableObject
- The object to encodeIOException
public static String encodeObject(Serializable serializableObject, int options) throws IOException
Valid options:
GZIP: gzip-compresses object before encoding it. DONT_BREAK_LINES: don't break lines at 76 characters <i>Note: Technically, this makes your encoding non-compliant.</i>
Example: encodeObject( myObj, Base64.GZIP )
or
Example:
encodeObject( myObj, Base64.GZIP | Base64.DONT_BREAK_LINES )
serializableObject
- The object to encodeoptions
- Specified optionsIOException
GZIP
,
DONT_BREAK_LINES
public static String encodeBytes(byte[] source) throws IOException
source
- The data to convertIOException
public static String encodeBytes(byte[] source, int options) throws IOException
Valid options:
GZIP: gzip-compresses object before encoding it. DONT_BREAK_LINES: don't break lines at 76 characters <i>Note: Technically, this makes your encoding non-compliant.</i>
Example: encodeBytes( myData, Base64.GZIP )
or
Example:
encodeBytes( myData, Base64.GZIP | Base64.DONT_BREAK_LINES )
source
- The data to convertoptions
- Specified optionsIOException
GZIP
,
DONT_BREAK_LINES
public static String encodeBytes(byte[] source, int off, int len) throws IOException
source
- The data to convertoff
- Offset in array where conversion should beginlen
- Length of data to convertIOException
public static String encodeBytes(byte[] source, int off, int len, int options) throws IOException
Valid options:
GZIP: gzip-compresses object before encoding it. DONT_BREAK_LINES: don't break lines at 76 characters <i>Note: Technically, this makes your encoding non-compliant.</i>
Example: encodeBytes( myData, Base64.GZIP )
or
Example:
encodeBytes( myData, Base64.GZIP | Base64.DONT_BREAK_LINES )
source
- The data to convertoff
- Offset in array where conversion should beginlen
- Length of data to convertoptions
- Specified optionsIOException
GZIP
,
DONT_BREAK_LINES
public static byte[] decode(byte[] source, int off, int len)
source
- The Base64 encoded dataoff
- The offset of where to begin decodinglen
- The length of characters to decodepublic static byte[] decodeWithoutUnzipping(String encodedValue)
decode(String)
only that it will not check
the decoded value for GZip compression and thus will not
decompress anythingencodedValue
- a Base64 encoded valuepublic static byte[] decode(String encodedValue)
s
. If the decoded value
has a GZip Magic Number header (GZIPInputStream.GZIP_MAGIC
)
then it automatically unzips the decoded valueencodedValue
- a Base64 encoded valuepublic static Object decodeToObject(String encodedObject) throws IOException, ClassNotFoundException
encodedObject
- The Base64 data to decodeIOException
ClassNotFoundException
public static void encodeToFile(byte[] dataToEncode, String filename) throws IOException
dataToEncode
- byte array of data to encode in base64 formfilename
- Filename for saving encoded dataIOException
public static void decodeToFile(String dataToDecode, String filename) throws IOException
dataToDecode
- Base64-encoded data as a stringfilename
- Filename for saving decoded dataIOException
public static byte[] decodeFromFile(String filename) throws IOException
filename
- Filename for reading encoded dataIOException
public static String encodeFromFile(String filename) throws IOException
filename
- Filename for reading binary dataIOException
Copyright © 2003–2016 MuleSoft, Inc.. All rights reserved.