|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.systemsbiology.jrap.Base64
public final class Base64
Encodes and decodes to and from Base64 notation.
Change Log:
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/xmlizable periodically to check for updates or to contribute improvements.
Nested Class Summary | |
---|---|
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 | |
---|---|
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 | |
---|---|
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 |
---|
public static final boolean ENCODE
public static final boolean DECODE
public static final boolean COMPRESS
public static final boolean DONT_COMPRESS
Method Detail |
---|
public static void main(java.lang.String[] args)
public static java.lang.String encodeObject(java.io.Serializable serializableObject)
serializableObject
- The object to encode
public static java.lang.String encodeObject(java.io.Serializable serializableObject, boolean breakLines)
serializableObject
- The object to encodebreakLines
- Break lines at 80 characters or less.
public static java.lang.String encodeBytes(byte[] source)
encodeBytes( source, 0, source.length )
source
- The data to convertpublic static java.lang.String encodeBytes(byte[] source, boolean breakLines)
encodeBytes( source, 0, source.length )
source
- The data to convertbreakLines
- Break lines at 80 characters or less.public static java.lang.String encodeBytes(byte[] source, int off, int len)
source
- The data to convertoff
- Offset in array where conversion should beginlen
- Length of data to convertpublic static java.lang.String encodeBytes(byte[] source, int off, int len, boolean breakLines)
source
- The data to convertoff
- Offset in array where conversion should beginlen
- Length of data to convertbreakLines
- Break lines at 80 characters or less.public static java.lang.String encodeString(java.lang.String s)
s
- the string to encode
public static java.lang.String encodeString(java.lang.String s, boolean breakLines)
s
- the string to encodebreakLines
- Break lines at 80 characters or less.
public static byte[] readFile(java.lang.String file, boolean encode)
file
- The file to readencode
- Whether or not to encode file as it is read.
public static byte[] readFile(java.io.File file, boolean encode)
file
- The file to readencode
- Whether or not to encode file as it is read.
public static boolean writeFile(byte[] data, java.lang.String file, boolean encode)
data
- The array to write to a file.file
- The file to write to.encode
- Whether or not to encode the data.
public static boolean writeFile(byte[] data, java.io.File file, boolean encode)
data
- The array to write to a file.file
- The file to write to.encode
- Whether or not to encode the data.
public static boolean writeFile(byte[] data, int offset, int length, java.io.File file, boolean encode)
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.
public static java.lang.String encodeFromFile(java.lang.String rawfile)
rawfile
- The file to read
public static byte[] decodeFromFile(java.lang.String encfile)
encfile
- The file to read
public static boolean encodeToFile(byte[] rawdata, java.lang.String file)
rawdata
- The data to write.file
- The file to read.
public static boolean decodeToFile(byte[] encdata, java.lang.String file)
encdata
- The data to write.file
- The file to read.
public static byte[] decode(java.lang.String s)
s
- the string to decode
public static java.lang.String decodeToString(java.lang.String s)
new String( decode( s ) )
s
- the strind to decode
public static java.lang.Object decodeToObject(java.lang.String encodedObject)
encodedObject
- The Base64 data to decode
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 decode
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |