Base64 (ph-commons 8.6.4 API)

java.lang.Object
- com.helger.commons.base64.Base64

```
@Immutable
public final class Base64
extends Object
```
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:
- v2.3.7 - Fixed subtle bug when base 64 input stream contained the value 01111111, which is an invalid base 64 character but should not throw an ArrayIndexOutOfBoundsException either. Led to discovery of mishandling (or potential for better handling) of other bad input characters. You should now get an IOException if you try decoding something that has bad characters in it.
- v2.3.6 - Fixed bug when breaking lines and the final byte of the encoded string ended in the last column; the buffer was not properly shrunk and contained an extra (null) byte that made it into the string.
- v2.3.5 - Fixed bug in encodeFromFile(java.lang.String) where estimated buffer size was wrong for files of size 31, 34, and 37 bytes.
- v2.3.4 - Fixed bug when working with gzipped streams whereby flushing the Base64.OutputStream closed the Base64 encoding (by padding with equals signs) too soon. Also added an option to suppress the automatic decoding of gzipped streams. Also added experimental support for specifying a class loader when using the decodeToObject(java.lang.String, int, java.lang.ClassLoader) method.
- v2.3.3 - Changed default char encoding to US-ASCII which reduces the internal Java footprint with its CharEncoders and so forth. Fixed some javadocs that were inconsistent. Removed imports and specified things like IOException explicitly inline.
- v2.3.2 - Reduced memory footprint! Finally refined the "guessing" of how big the final encoded data will be so that the code doesn't have to create two output arrays: an oversized initial one and then a final, exact-sized one. Big win when using the encodeBytesToBytes(byte[]) family of methods (and not using the gzip options which uses a different mechanism with streams and stuff).
- v2.3.1 - Added 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.
- v2.3 - This is not a drop-in replacement! This is two years of comments and bug fixes queued up and finally executed. Thanks to everyone who sent me stuff, and I'm sorry I wasn't able to distribute your fixes to everyone else. Much bad coding was cleaned up including throwing exceptions where necessary instead of returning null values or something similar. Here are some changes that may affect you:
  - Does not break lines, by default. This is to keep in compliance with RFC3548.
  - Throws exceptions instead of returning null values. Because some operations (especially those that may permit the GZIP option) use IO streams, there is a possiblity of an IOException being thrown. After some discussion and thought, I've changed the behavior of the methods to throw IOExceptions rather than return null if ever there's an error. I think this is more appropriate, though it will require some changes to your code. Sorry, it should have been done this way to begin with.
  - Removed all references to System.out, System.err, and the like. Shame on me. All I can say is sorry they were ever there.
  - Throws NullPointerExceptions and IllegalArgumentExceptions as needed such as when passed arrays are null or offsets are invalid.
  - Cleaned up as much javadoc as I could to avoid any javadoc warnings. This was especially annoying before for people who were thorough in their own projects and then had gobs of javadoc warnings on this file.
- v2.2.1 - Fixed bug using URL_SAFE and ORDERED encodings. Fixed bug when using very small files (~< 40 bytes).
- v2.2 - Added some helper methods for encoding/decoding directly from one file to the next. Also added a main() method to support command line encoding/decoding from one file to the next. Also added these Base64 dialects:
  1. The default is RFC3548 format.
  2. Calling Base64.setFormat(Base64.BASE64_FORMAT.URLSAFE_FORMAT) generates URL and file name friendly format as described in Section 4 of RFC3548. http://www.faqs.org/rfcs/rfc3548.html
  3. Calling Base64.setFormat(Base64.BASE64_FORMAT.ORDERED_FORMAT) generates URL and file name friendly format that preserves lexical ordering as described in http://www.faqs.org/qa/rfcc-1940.html
  Special thanks to Jim Kellerman at http://www.powerset.com/ for contributing the new Base64 dialects.
- v2.1 - Cleaned up javadoc comments and unused variables and methods. Added some convenience methods for reading and writing to and from files.
- v2.0.2 - Now specifies UTF-8 encoding in places where the code fails on systems with other encodings (like EBCDIC).
- v2.0.1 - Fixed an error when decoding a single byte, that is, when the encoded data was a single byte.
- v2.0 - I got rid of methods that used booleans to set options. Now everything is more consolidated and cleaner. The code now detects when data that's being decoded is gzip-compressed and will decompress it automatically. Generally things are cleaner. You'll probably have to change some method calls that you were making to support the new options format (ints that you "OR" together).
- v1.5.1 - Fixed bug when decompressing and decoding to a byte[] using decode( String s, boolean gzipCompressed ). Added the ability to "suspend" encoding in the Output Stream so you can turn on and off the encoding if you need to embed base64 data in an otherwise "normal" stream (like an XML file).
- v1.5 - Output stream pases on flush() command but doesn't do anything itself. This helps when using GZIP streams. Added the ability to GZip-compress objects before encoding them.
- v1.4 - Added helper methods to read/write files.
- v1.3.6 - Fixed OutputStream.flush() so that 'position' is reset.
- v1.3.5 - Added flag to turn on and off line breaks. Fixed bug in input stream where last buffer being read, if not completely full, was not returned.
- v1.3.4 - Fixed when "improperly padded stream" error was thrown at the wrong time.
- v1.3.3 - Fixed I/O streams which were totally messed up.
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.
Version:

2.3.7

Author:

Robert Harder, rob@iharder.net

Field Summary

Fields
Modifier and Type	Field and Description
`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 byte`	`EQUALS_SIGN` The equals sign (=) as a byte.
`static int`	`GZIP` Specify that data should be gzip-compressed in second bit.
`static int`	`MAX_LINE_LENGTH` Maximum line length (76) of Base64 output.
`static byte`	`NEW_LINE` The new line character (\n) as a byte.
`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 Charset`	`PREFERRED_ENCODING` Preferred encoding.
`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

All Methods Static Methods Concrete Methods
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(byte[] source, int options)` Low-level access to decoding ASCII characters in the form of a byte array.
`static byte[]`	`decode(byte[] aSource, int nOfs, int nLen, int nOptions)` 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 byte[]`	`decode(String s, int options)` 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 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 Object`	`decodeToObject(String encodedObject, int options, ClassLoader loader)` 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 String`	`encodeBytes(byte[] source, int off, int len, int nOptions)` 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[] aSource, int nOfs, int nLen, int nOptions)` Similar to `encodeBytes(byte[], int, int, int)` 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`	`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 aSerializableObject, int nOptions)` Serializes an object and returns the Base64-encoded version of that serialized object.
`static void`	`encodeToFile(byte[] aDataToEncode, String sFilename)` Convenience method for encoding data to a file.
`static byte[]`	`safeDecode(byte[] aEncodedBytes)` Decode the byte array.
`static byte[]`	`safeDecode(byte[] aEncodedBytes, int nOptions)` Decode the byte array.
`static byte[]`	`safeDecode(byte[] aEncodedBytes, int nOfs, int nLen)` Decode the byte array.
`static byte[]`	`safeDecode(byte[] aEncodedBytes, int nOfs, int nLen, int nOptions)` Decode the byte array.
`static byte[]`	`safeDecode(String sEncoded)` Decode the string with the default encoding (US-ASCII is the preferred one).
`static byte[]`	`safeDecode(String sEncoded, int nOptions)` Decode the string with the default encoding (US-ASCII is the preferred one).
`static String`	`safeDecodeAsString(byte[] aEncodedBytes, Charset aCharset)` Decode the byte array and convert it to a string.
`static String`	`safeDecodeAsString(byte[] aEncodedBytes, int nOfs, int nLength, Charset aCharset)` Decode the byte array and convert it to a string.
`static String`	`safeDecodeAsString(String sEncoded, Charset aCharset)` Decode the string and convert it back to a string.
`static String`	`safeEncode(String s, Charset aCharset)`
`static String`	`safeEncodeBytes(byte[] aDecoded)`
`static String`	`safeEncodeBytes(byte[] aDecoded, int nOptions)`
`static String`	`safeEncodeBytes(byte[] aDecoded, int nOfs, int nLen)`
`static String`	`safeEncodeBytes(byte[] aDecoded, int nOfs, int nLen, int nOptions)`
`static byte[]`	`safeEncodeBytesToBytes(byte[] aDecoded)`
`static byte[]`	`safeEncodeBytesToBytes(byte[] aDecoded, int nOptions)`
`static byte[]`	`safeEncodeBytesToBytes(byte[] aDecoded, int nOfs, int nLen)`
`static byte[]`	`safeEncodeBytesToBytes(byte[] aDecoded, int nOfs, int nLen, int nOptions)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- NO_OPTIONS
```
public static final int NO_OPTIONS
```
  No options specified. Value is zero.
  
  See Also:
  
  Constant Field Values
- ENCODE
```
public static final int ENCODE
```
  Specify encoding in first bit. Value is one.
  
  See Also:
  
  Constant Field Values
- DECODE
```
public static final int DECODE
```
  Specify decoding in first bit. Value is zero.
  
  See Also:
  
  Constant Field Values
- GZIP
```
public static final int GZIP
```
  Specify that data should be gzip-compressed in second bit. Value is two.
  
  See Also:
  
  Constant Field Values
- DONT_GUNZIP
```
public static final int DONT_GUNZIP
```
  Specify that gzipped data should not be automatically gunzipped.
  
  See Also:
  
  Constant Field Values
- DO_BREAK_LINES
```
public static final int DO_BREAK_LINES
```
  Do break lines when encoding. Value is 8.
  
  See Also:
  
  Constant Field Values
- URL_SAFE
```
public static final 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. It is important to note that data encoded this way is not officially valid Base64, or at the very least should not be called Base64 without also specifying that is was encoded using the URL- and Filename-safe dialect.
  
  See Also:
  
  Constant Field Values
- ORDERED
```
public static final int ORDERED
```
  Encode using the special "ordered" dialect of Base64 described here: http://www.faqs.org/qa/ rfcc- 1940. html.
  
  See Also:
  
  Constant Field Values
- MAX_LINE_LENGTH
```
public static final int MAX_LINE_LENGTH
```
  Maximum line length (76) of Base64 output.
  
  See Also:
  
  Constant Field Values
- EQUALS_SIGN
```
public static final byte EQUALS_SIGN
```
  The equals sign (=) as a byte.
  
  See Also:
  
  Constant Field Values
- NEW_LINE
```
public static final byte NEW_LINE
```
  The new line character (\n) as a byte.
  
  See Also:
  
  Constant Field Values
- PREFERRED_ENCODING
```
public static final Charset PREFERRED_ENCODING
```
  Preferred encoding.

Method Detail

encode
```
public static void encode(@Nonnull
                          ByteBuffer raw,
                          @Nonnull
                          ByteBuffer encoded)
```
Performs Base64 encoding on the 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.

Parameters:

raw - input buffer

encoded - output buffer

Since:

2.3

encode
```
public static void encode(@Nonnull
                          ByteBuffer raw,
                          @Nonnull
                          CharBuffer encoded)
```
Performs Base64 encoding on the 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.

Parameters:

raw - input buffer

encoded - output buffer

Since:

2.3

encodeObject
```
public static String encodeObject(@Nonnull
                                  Serializable serializableObject)
                           throws IOException
```
Serializes an object and returns the Base64-encoded version of that serialized object.
As of v 2.3, if the object cannot be serialized or there is another error, the method will throw an 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.

Parameters:

serializableObject - The object to encode

Returns:

The Base64-encoded object

Throws:

IOException - if there is an error

NullPointerException - if serializedObject is null

Since:

1.4

encodeObject
```
@Nonnull
public static String encodeObject(@Nonnull
                                            Serializable aSerializableObject,
                                            int nOptions)
                                     throws IOException
```
Serializes an object and returns the Base64-encoded version of that serialized object.
As of v 2.3, if the object cannot be serialized or there is another error, the method will throw an 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 )
Parameters:

aSerializableObject - The object to encode

nOptions - Specified options

Returns:

The Base64-encoded object

Throws:

IOException - if there is an error

Since:

2.0

See Also:

GZIP, DO_BREAK_LINES

encodeBytes
```
@Nonnull
public static String encodeBytes(@Nonnull
                                           byte[] source)
```
Encodes a byte array into Base64 notation. Does not GZip-compress data.

Parameters:

source - The data to convert

Returns:

The data in Base64-encoded form

Throws:

NullPointerException - if source array is null

Since:

1.4

encodeBytes
```
@Nonnull
public static String encodeBytes(@Nonnull
                                           byte[] source,
                                           int options)
                                    throws IOException
```
Encodes a byte array into Base64 notation.
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 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.
Parameters:

source - The data to convert

options - Specified options

Returns:

The Base64-encoded data as a String

Throws:

IOException - if there is an error

NullPointerException - if source array is null

Since:

2.0

See Also:

GZIP, DO_BREAK_LINES

encodeBytes
```
@Nonnull
public static String encodeBytes(@Nonnull
                                           byte[] source,
                                           int off,
                                           int len)
```
Encodes a byte array into Base64 notation. Does not GZip-compress data.
As of v 2.3, if there is an error, the method will throw an 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.

Parameters:

source - The data to convert

off - Offset in array where conversion should begin

len - Length of data to convert

Returns:

The Base64-encoded data as a String

Throws:

NullPointerException - if source array is null

IllegalArgumentException - if source array, offset, or length are invalid

Since:

1.4

encodeBytes

@Nonnull
public static String encodeBytes(@Nonnull
                                           byte[] source,
                                           @Nonnegative
                                           int off,
                                           @Nonnegative
                                           int len,
                                           int nOptions)
                                    throws IOException

Encodes a byte array into Base64 notation.

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 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.

Parameters:: source - The data to convert; off - Offset in array where conversion should begin; len - Length of data to convert; nOptions - Specified options
Returns:: The Base64-encoded data as a String
Throws:: IOException - if there is an error; NullPointerException - if source array is null; IllegalArgumentException - if source array, offset, or length are invalid
Since:: 2.0
See Also:: GZIP, DO_BREAK_LINES

encodeBytesToBytes
```
@Nonnull
 @ReturnsMutableCopy
public static byte[] encodeBytesToBytes(@Nonnull
                                                                        byte[] source)
```
Similar to 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.

Parameters:

source - The data to convert

Returns:

The Base64-encoded data as a byte[] (of ASCII characters)

Throws:

NullPointerException - if source array is null

Since:

2.3.1

encodeBytesToBytes

@Nonnull
 @ReturnsMutableCopy
public static byte[] encodeBytesToBytes(@Nonnull
                                                                        byte[] aSource,
                                                                        @Nonnegative
                                                                        int nOfs,
                                                                        @Nonnegative
                                                                        int nLen,
                                                                        int nOptions)
                                                                 throws IOException

Similar to 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.

Parameters:: aSource - The data to convert; nOfs - Offset in array where conversion should begin; nLen - Length of data to convert; nOptions - Specified options
Returns:: The Base64-encoded data as a String
Throws:: IOException - if there is an error; NullPointerException - if source array is null; IllegalArgumentException - if source array, offset, or length are invalid
Since:: 2.3.1
See Also:: GZIP, DO_BREAK_LINES

decode
```
@Nonnull
 @ReturnsMutableCopy
public static byte[] decode(@Nonnull
                                                            byte[] source)
                                                     throws IOException
```
Low-level access to decoding ASCII characters in the form of a byte array. Ignores GUNZIP option, if it's set. This is not generally a recommended method, although it is used internally as part of the decoding process. Special case: if len = 0, an empty array is returned. Still, if you need more speed and reduced memory footprint (and aren't gzipping), consider this method.

Parameters:

source - The Base64 encoded data

Returns:

decoded data

Throws:

IOException - In case of error

Since:

2.3.1

decode
```
@Nonnull
 @ReturnsMutableCopy
public static byte[] decode(@Nonnull
                                                            byte[] source,
                                                            int options)
                                                     throws IOException
```
Low-level access to decoding ASCII characters in the form of a byte array. Ignores GUNZIP option, if it's set. This is not generally a recommended method, although it is used internally as part of the decoding process. Special case: if len = 0, an empty array is returned. Still, if you need more speed and reduced memory footprint (and aren't gzipping), consider this method.

Parameters:

source - The Base64 encoded data

options - Can specify options such as alphabet type to use

Returns:

decoded data

Throws:

IOException - In case of error

Since:

2.3.1

decode
```
@Nonnull
 @ReturnsMutableCopy
public static byte[] decode(@Nonnull
                                                            byte[] aSource,
                                                            int nOfs,
                                                            int nLen,
                                                            int nOptions)
                                                     throws IOException
```
Low-level access to decoding ASCII characters in the form of a byte array. Ignores GUNZIP option, if it's set. This is not generally a recommended method, although it is used internally as part of the decoding process. Special case: if len = 0, an empty array is returned. Still, if you need more speed and reduced memory footprint (and aren't gzipping), consider this method.

Parameters:

aSource - The Base64 encoded data

nOfs - The offset of where to begin decoding

nLen - The length of characters to decode

nOptions - Can specify options such as alphabet type to use

Returns:

decoded data

Throws:

IOException - If bogus characters exist in source data

Since:

1.3

decode

@Nonnull
 @ReturnsMutableCopy
public static byte[] decode(@Nonnull
                                                            String s)
                                                     throws IOException

Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.

Parameters:: s - the string to decode
Returns:: the decoded data
Throws:: IOException - If there is a problem
Since:: 1.4

decode

@Nonnull
 @ReturnsMutableCopy
public static byte[] decode(@Nonnull
                                                            String s,
                                                            int options)
                                                     throws IOException

Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.

Parameters:: s - the string to decode; options - encode options such as URL_SAFE
Returns:: the decoded data
Throws:: IOException - if there is an error; NullPointerException - if s is null
Since:: 1.4

decodeToObject
```
public static Object decodeToObject(@Nonnull
                                    String encodedObject)
                             throws IOException,
                                    ClassNotFoundException
```
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

Returns:

The decoded and deserialized object

Throws:

NullPointerException - if encodedObject is null

IOException - if there is a general error

ClassNotFoundException - if the decoded object is of a class that cannot be found by the JVM

Since:

1.5

decodeToObject
```
public static Object decodeToObject(@Nonnull
                                    String encodedObject,
                                    int options,
                                    @Nullable
                                    ClassLoader loader)
                             throws IOException,
                                    ClassNotFoundException
```
Attempts to decode Base64 data and deserialize a Java Object within. Returns null if there was an error. If loader is not null, it will be the class loader used when deserializing.

Parameters:

encodedObject - The Base64 data to decode

options - Various parameters related to decoding

loader - Optional class loader to use in deserializing classes.

Returns:

The decoded and deserialized object

Throws:

NullPointerException - if encodedObject is null

IOException - if there is a general error

ClassNotFoundException - if the decoded object is of a class that cannot be found by the JVM

Since:

2.3.4

encodeToFile
```
public static void encodeToFile(@Nonnull
                                byte[] aDataToEncode,
                                String sFilename)
                         throws IOException
```
Convenience method for encoding data to a file.
As of v 2.3, if there is a error, the method will throw an 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.

Parameters:

aDataToEncode - byte array of data to encode in base64 form

sFilename - Filename for saving encoded data

Throws:

IOException - if there is an error

NullPointerException - if dataToEncode is null

Since:

2.1

decodeToFile
```
public static void decodeToFile(@Nonnull
                                String dataToDecode,
                                @Nonnull
                                String filename)
                         throws IOException
```
Convenience method for decoding data to a file.
As of v 2.3, if there is a error, the method will throw an 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.

Parameters:

dataToDecode - Base64-encoded data as a string

filename - Filename for saving decoded data

Throws:

IOException - if there is an error

Since:

2.1

decodeFromFile
```
@Nonnull
 @ReturnsMutableCopy
public static byte[] decodeFromFile(@Nonnull
                                                                    String filename)
                                                             throws IOException
```
Convenience method for reading a base64-encoded file and decoding it.
As of v 2.3, if there is a error, the method will throw an 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.

Parameters:

filename - Filename for reading encoded data

Returns:

decoded byte array

Throws:

IOException - if there is an error

Since:

2.1

encodeFromFile
```
@Nonnull
public static String encodeFromFile(@Nonnull
                                              String filename)
                                       throws IOException
```
Convenience method for reading a binary file and base64-encoding it.
As of v 2.3, if there is a error, the method will throw an 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.

Parameters:

filename - Filename for reading binary data

Returns:

base64-encoded string

Throws:

IOException - if there is an error

Since:

2.1

encodeFileToFile

public static void encodeFileToFile(@Nonnull
                                    String infile,
                                    @Nonnull
                                    String outfile)
                             throws IOException

Reads infile and encodes it to outfile.

Parameters:: infile - Input file; outfile - Output file
Throws:: IOException - if there is an error
Since:: 2.2

decodeFileToFile

public static void decodeFileToFile(@Nonnull
                                    String infile,
                                    @Nonnull
                                    String outfile)
                             throws IOException

Reads infile and decodes it to outfile.

Parameters:: infile - Input file; outfile - Output file
Throws:: IOException - if there is an error
Since:: 2.2

safeDecode

@Nullable
 @ReturnsMutableCopy
public static byte[] safeDecode(@Nullable
                                                                 String sEncoded)

Decode the string with the default encoding (US-ASCII is the preferred one).

Parameters:: sEncoded - The encoded string.
Returns:: null if decoding failed.

safeDecode

@Nullable
 @ReturnsMutableCopy
public static byte[] safeDecode(@Nullable
                                                                 String sEncoded,
                                                                 int nOptions)

Decode the string with the default encoding (US-ASCII is the preferred one).

Parameters:: sEncoded - The encoded string.; nOptions - Decoding options.
Returns:: null if decoding failed.

safeDecode

@Nullable
 @ReturnsMutableCopy
public static byte[] safeDecode(@Nullable
                                                                 byte[] aEncodedBytes)

Decode the byte array.

Parameters:: aEncodedBytes - The encoded byte array.
Returns:: null if decoding failed.

safeDecode

@Nullable
 @ReturnsMutableCopy
public static byte[] safeDecode(@Nullable
                                                                 byte[] aEncodedBytes,
                                                                 int nOptions)

Decode the byte array.

Parameters:: aEncodedBytes - The encoded byte array.; nOptions - Decoding options.
Returns:: null if decoding failed.

safeDecode

@Nullable
 @ReturnsMutableCopy
public static byte[] safeDecode(@Nullable
                                                                 byte[] aEncodedBytes,
                                                                 @Nonnegative
                                                                 int nOfs,
                                                                 @Nonnegative
                                                                 int nLen)

Decode the byte array.

Parameters:: aEncodedBytes - The encoded byte array.; nOfs - The offset of where to begin decoding; nLen - The number of characters to decode
Returns:: null if decoding failed.

safeDecode

@Nullable
 @ReturnsMutableCopy
public static byte[] safeDecode(@Nullable
                                                                 byte[] aEncodedBytes,
                                                                 @Nonnegative
                                                                 int nOfs,
                                                                 @Nonnegative
                                                                 int nLen,
                                                                 int nOptions)

Decode the byte array.

Parameters:: aEncodedBytes - The encoded byte array.; nOfs - The offset of where to begin decoding; nLen - The number of characters to decode; nOptions - Decoding options.
Returns:: null if decoding failed.

safeDecodeAsString

@Nullable
public static String safeDecodeAsString(@Nullable
                                                   String sEncoded,
                                                   @Nonnull
                                                   Charset aCharset)

Decode the string and convert it back to a string.

Parameters:: sEncoded - The encoded string.; aCharset - The character set to be used.
Returns:: null if decoding failed.

safeDecodeAsString

@Nullable
public static String safeDecodeAsString(@Nullable
                                                   byte[] aEncodedBytes,
                                                   @Nonnull
                                                   Charset aCharset)

Decode the byte array and convert it to a string.

Parameters:: aEncodedBytes - The encoded byte array.; aCharset - The character set to be used.
Returns:: null if decoding failed.

safeDecodeAsString

@Nullable
public static String safeDecodeAsString(@Nullable
                                                   byte[] aEncodedBytes,
                                                   @Nonnegative
                                                   int nOfs,
                                                   @Nonnegative
                                                   int nLength,
                                                   @Nonnull
                                                   Charset aCharset)

Decode the byte array and convert it to a string.

Parameters:: aEncodedBytes - The encoded byte array.; nOfs - Offset into array; nLength - Number of bytes to decode.; aCharset - The character set to be used.
Returns:: null if decoding failed.

safeEncodeBytesToBytes

@Nullable
 @ReturnsMutableCopy
public static byte[] safeEncodeBytesToBytes(@Nullable
                                                                             byte[] aDecoded)

safeEncodeBytesToBytes

@Nullable
 @ReturnsMutableCopy
public static byte[] safeEncodeBytesToBytes(@Nullable
                                                                             byte[] aDecoded,
                                                                             int nOptions)

safeEncodeBytesToBytes

@Nullable
 @ReturnsMutableCopy
public static byte[] safeEncodeBytesToBytes(@Nullable
                                                                             byte[] aDecoded,
                                                                             @Nonnegative
                                                                             int nOfs,
                                                                             @Nonnegative
                                                                             int nLen)

safeEncodeBytesToBytes

@Nullable
 @ReturnsMutableCopy
public static byte[] safeEncodeBytesToBytes(@Nullable
                                                                             byte[] aDecoded,
                                                                             @Nonnegative
                                                                             int nOfs,
                                                                             @Nonnegative
                                                                             int nLen,
                                                                             int nOptions)

safeEncodeBytes

@Nullable
 @ReturnsMutableCopy
public static String safeEncodeBytes(@Nullable
                                                                      byte[] aDecoded)

safeEncodeBytes

@Nullable
 @ReturnsMutableCopy
public static String safeEncodeBytes(@Nullable
                                                                      byte[] aDecoded,
                                                                      int nOptions)

safeEncodeBytes

@Nullable
 @ReturnsMutableCopy
public static String safeEncodeBytes(@Nullable
                                                                      byte[] aDecoded,
                                                                      @Nonnegative
                                                                      int nOfs,
                                                                      @Nonnegative
                                                                      int nLen)

safeEncodeBytes

@Nullable
 @ReturnsMutableCopy
public static String safeEncodeBytes(@Nullable
                                                                      byte[] aDecoded,
                                                                      @Nonnegative
                                                                      int nOfs,
                                                                      @Nonnegative
                                                                      int nLen,
                                                                      int nOptions)

safeEncode

@Nullable
public static String safeEncode(@Nonnull
                                           String s,
                                           @Nonnull
                                           Charset aCharset)

Parameters:: s - The string to be encoded; aCharset - The charset to be used
Returns:: The encoded byte array.

Class Base64

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_OPTIONS

ENCODE

DECODE

GZIP

DONT_GUNZIP

DO_BREAK_LINES

URL_SAFE

ORDERED

MAX_LINE_LENGTH

EQUALS_SIGN

NEW_LINE

PREFERRED_ENCODING

Method Detail

encode

encode

encodeObject

encodeObject

encodeBytes

encodeBytes

encodeBytes

encodeBytes

encodeBytesToBytes

encodeBytesToBytes

decode

decode

decode

decode

decode

decodeToObject

decodeToObject

encodeToFile

decodeToFile

decodeFromFile

encodeFromFile

encodeFileToFile

decodeFileToFile

safeDecode

safeDecode

safeDecode

safeDecode

safeDecode

safeDecode

safeDecodeAsString

safeDecodeAsString

safeDecodeAsString

safeEncodeBytesToBytes

safeEncodeBytesToBytes

safeEncodeBytesToBytes

safeEncodeBytesToBytes

safeEncodeBytes

safeEncodeBytes

safeEncodeBytes

safeEncodeBytes

safeEncode