Base64 Class Reference

List of all members.

Static Public Member Functions
static String	encodeObject (java.io.Serializable serializableObject)
static String	encodeObject (java.io.Serializable serializableObject, int options)
static String	encodeBytes (byte[] source)
static String	encodeBytes (byte[] source, int options)
static String	encodeBytes (byte[] source, int off, int len)
static String	encodeBytes (byte[] source, int off, int len, int options)
static byte[]	decode (byte[] source, int off, int len)
static byte[]	decode (String s)
static Object	decodeToObject (String encodedObject)
static boolean	encodeToFile (byte[] dataToEncode, String filename)
static boolean	decodeToFile (String dataToDecode, String filename)
static byte[]	decodeFromFile (String filename)
static String	encodeFromFile (String filename)
Static Public Attributes
static final int	NO_OPTIONS = 0
static final int	ENCODE = 1
static final int	DECODE = 0
static final int	GZIP = 2
static final int	DONT_BREAK_LINES = 8
Static Package Functions
	[static initializer]
Private Member Functions
	Base64 ()
Static Private Member Functions
static byte[]	encode3to4 (byte[] b4, byte[] threeBytes, int numSigBytes)
static byte[]	encode3to4 (byte[] source, int srcOffset, int numSigBytes, byte[] destination, int destOffset)
static int	decode4to3 (byte[] source, int srcOffset, byte[] destination, int destOffset)
Static Private Attributes
static final int	MAX_LINE_LENGTH = 76
static final byte	EQUALS_SIGN = (byte)'='
static final byte	NEW_LINE = (byte)'\n'
static final String	PREFERRED_ENCODING = "UTF-8"
static final byte[]	ALPHABET
static final byte[]	_NATIVE_ALPHABET
static final byte[]	DECODABET
static final byte	WHITE_SPACE_ENC = -5
static final byte	EQUALS_SIGN_ENC = -1
Classes
class	InputStream
class	OutputStream

---

Detailed Description

Encodes and decodes to and from Base64 notation.

Change Log:

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

Author:

Robert Harder

rob@iharder.net

Version:

2.1

Definition at line 48 of file Base64.java.

---

Constructor & Destructor Documentation

Base64::Base64 (   )  [inline, private]

Defeats instantiation. Definition at line 170 of file Base64.java. {}

---

Member Function Documentation

Base64::[static initializer] (   )  [inline, static, package]

Determine which ALPHABET to use.

static byte [] Base64::decode (  String  s  )  [inline, static]

Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it. Parameters: s  the string to decode Returns: the decoded data Since: 1.4 Definition at line 700 of file Base64.java. References decode(), and PREFERRED_ENCODING. { byte[] bytes; try { bytes = s.getBytes( PREFERRED_ENCODING ); } // end try catch( java.io.UnsupportedEncodingException uee ) { bytes = s.getBytes(); } // end catch //</change> // Decode bytes = decode( bytes, 0, bytes.length ); // Check to see if it's gzip-compressed // GZIP Magic Two-Byte Number: 0x8b1f (35615) if( bytes != null && bytes.length >= 4 ) { int head = ((int)bytes[0] & 0xff) | ((bytes[1] << 8) & 0xff00); if( java.util.zip.GZIPInputStream.GZIP_MAGIC == head ) { java.io.ByteArrayInputStream bais = null; java.util.zip.GZIPInputStream gzis = null; java.io.ByteArrayOutputStream baos = null; byte[] buffer = new byte[2048]; int length = 0; try { baos = new java.io.ByteArrayOutputStream(); bais = new java.io.ByteArrayInputStream( bytes ); gzis = new java.util.zip.GZIPInputStream( bais ); while( ( length = gzis.read( buffer ) ) >= 0 ) { baos.write(buffer,0,length); } // end while: reading input // No error? Get new bytes. bytes = baos.toByteArray(); } // end try catch( java.io.IOException e ) { // Just return originally-decoded bytes } // end catch finally { try{ baos.close(); } catch( Exception e ){} try{ gzis.close(); } catch( Exception e ){} try{ bais.close(); } catch( Exception e ){} } // end finally } // end if: gzipped } // end if: bytes.length >= 2 return bytes; } // end decode

static byte [] Base64::decode (  byte[]  source, int  off, int  len )  [inline, static]

Very low-level access to decoding ASCII characters in the form of a byte array. Does not support automatically gunzipping or any other "fancy" features. Parameters: source  The Base64 encoded data off  The offset of where to begin decoding len  The length of characters to decode Returns: decoded data Since: 1.3 Definition at line 643 of file Base64.java. References DECODABET, decode4to3(), EQUALS_SIGN, EQUALS_SIGN_ENC, and WHITE_SPACE_ENC. { int len34 = len * 3 / 4; byte[] outBuff = new byte[ len34 ]; // Upper limit on size of output int outBuffPosn = 0; byte[] b4 = new byte[4]; int b4Posn = 0; int i = 0; byte sbiCrop = 0; byte sbiDecode = 0; for( i = off; i < off+len; i++ ) { sbiCrop = (byte)(source[i] & 0x7f); // Only the low seven bits sbiDecode = DECODABET[ sbiCrop ]; if( sbiDecode >= WHITE_SPACE_ENC ) // White space, Equals sign or better { if( sbiDecode >= EQUALS_SIGN_ENC ) { b4[ b4Posn++ ] = sbiCrop; if( b4Posn > 3 ) { outBuffPosn += decode4to3( b4, 0, outBuff, outBuffPosn ); b4Posn = 0; // If that was the equals sign, break out of 'for' loop if( sbiCrop == EQUALS_SIGN ) break; } // end if: quartet built } // end if: equals sign or better } // end if: white space, equals sign or better else { System.err.println( "Bad Base64 input character at " + i + ": " + source[i] + "(decimal)" ); return null; } // end else: } // each input character byte[] out = new byte[ outBuffPosn ]; System.arraycopy( outBuff, 0, out, 0, outBuffPosn ); return out; } // end decode

static int Base64::decode4to3 (  byte[]  source, int  srcOffset, byte[]  destination, int  destOffset )  [inline, static, private]

Decodes four bytes from array source and writes the resulting bytes (up to three of them) to destination. The source and destination arrays can be manipulated anywhere along their length by specifying srcOffset and destOffset. This method does not check to make sure your arrays are large enough to accomodate srcOffset + 4 for the source array or destOffset + 3 for the destination array. This method returns the actual number of bytes that were converted from the Base64 encoding. Parameters: source  the array to convert srcOffset  the index where conversion begins destination  the array to hold the conversion destOffset  the index where output will be put Returns: the number of decoded bytes converted Since: 1.3 Definition at line 568 of file Base64.java. References DECODABET, and EQUALS_SIGN. { // Example: Dk== if( source[ srcOffset + 2] == EQUALS_SIGN ) { // Two ways to do the same thing. Don't know which way I like best. //int outBuff = ( ( DECODABET[ source[ srcOffset ] ] << 24 ) >>> 6 ) // | ( ( DECODABET[ source[ srcOffset + 1] ] << 24 ) >>> 12 ); int outBuff = ( ( DECODABET[ source[ srcOffset ] ] & 0xFF ) << 18 ) | ( ( DECODABET[ source[ srcOffset + 1] ] & 0xFF ) << 12 ); destination[ destOffset ] = (byte)( outBuff >>> 16 ); return 1; } // Example: DkL= else if( source[ srcOffset + 3 ] == EQUALS_SIGN ) { // Two ways to do the same thing. Don't know which way I like best. //int outBuff = ( ( DECODABET[ source[ srcOffset ] ] << 24 ) >>> 6 ) // | ( ( DECODABET[ source[ srcOffset + 1 ] ] << 24 ) >>> 12 ) // | ( ( DECODABET[ source[ srcOffset + 2 ] ] << 24 ) >>> 18 ); int outBuff = ( ( DECODABET[ source[ srcOffset ] ] & 0xFF ) << 18 ) | ( ( DECODABET[ source[ srcOffset + 1 ] ] & 0xFF ) << 12 ) | ( ( DECODABET[ source[ srcOffset + 2 ] ] & 0xFF ) << 6 ); destination[ destOffset ] = (byte)( outBuff >>> 16 ); destination[ destOffset + 1 ] = (byte)( outBuff >>> 8 ); return 2; } // Example: DkLE else { try{ // Two ways to do the same thing. Don't know which way I like best. //int outBuff = ( ( DECODABET[ source[ srcOffset ] ] << 24 ) >>> 6 ) // | ( ( DECODABET[ source[ srcOffset + 1 ] ] << 24 ) >>> 12 ) // | ( ( DECODABET[ source[ srcOffset + 2 ] ] << 24 ) >>> 18 ) // | ( ( DECODABET[ source[ srcOffset + 3 ] ] << 24 ) >>> 24 ); int outBuff = ( ( DECODABET[ source[ srcOffset ] ] & 0xFF ) << 18 ) | ( ( DECODABET[ source[ srcOffset + 1 ] ] & 0xFF ) << 12 ) | ( ( DECODABET[ source[ srcOffset + 2 ] ] & 0xFF ) << 6) | ( ( DECODABET[ source[ srcOffset + 3 ] ] & 0xFF ) ); destination[ destOffset ] = (byte)( outBuff >> 16 ); destination[ destOffset + 1 ] = (byte)( outBuff >> 8 ); destination[ destOffset + 2 ] = (byte)( outBuff ); return 3; }catch( Exception e){ System.out.println(""+source[srcOffset]+ ": " + ( DECODABET[ source[ srcOffset ] ] ) ); System.out.println(""+source[srcOffset+1]+ ": " + ( DECODABET[ source[ srcOffset + 1 ] ] ) ); System.out.println(""+source[srcOffset+2]+ ": " + ( DECODABET[ source[ srcOffset + 2 ] ] ) ); System.out.println(""+source[srcOffset+3]+ ": " + ( DECODABET[ source[ srcOffset + 3 ] ] ) ); return -1; } //e nd catch } } // end decodeToBytes

static byte [] Base64::decodeFromFile (  String  filename  )  [inline, static]

Convenience method for reading a base64-encoded file and decoding it. Parameters: filename  Filename for reading encoded data Returns: decoded byte array or null if unsuccessful Since: 2.1 Definition at line 889 of file Base64.java. { byte[] decodedData = null; Base64.InputStream bis = null; try { // Set up some useful variables java.io.File file = new java.io.File( filename ); byte[] buffer = null; int length = 0; int numBytes = 0; // Check for size of file if( file.length() > Integer.MAX_VALUE ) { System.err.println( "File is too big for this convenience method (" + file.length() + " bytes)." ); return null; } // end if: file too big for int index buffer = new byte[ (int)file.length() ]; // Open a stream bis = new Base64.InputStream( new java.io.BufferedInputStream( new java.io.FileInputStream( file ) ), Base64.DECODE ); // Read until done while( ( numBytes = bis.read( buffer, length, 4096 ) ) >= 0 ) length += numBytes; // Save in a variable to return decodedData = new byte[ length ]; System.arraycopy( buffer, 0, decodedData, 0, length ); } // end try catch( java.io.IOException e ) { System.err.println( "Error decoding from file " + filename ); } // end catch: IOException finally { try{ bis.close(); } catch( Exception e) {} } // end finally return decodedData; } // end decodeFromFile

static boolean Base64::decodeToFile (  String  dataToDecode, String  filename )  [inline, static]

Convenience method for decoding data to a file. Parameters: dataToDecode  Base64-encoded data as a string filename  Filename for saving decoded data Returns: true if successful, false otherwise Since: 2.1 Definition at line 854 of file Base64.java. References PREFERRED_ENCODING. { boolean success = false; Base64.OutputStream bos = null; try { bos = new Base64.OutputStream( new java.io.FileOutputStream( filename ), Base64.DECODE ); bos.write( dataToDecode.getBytes( PREFERRED_ENCODING ) ); success = true; } // end try catch( java.io.IOException e ) { success = false; } // end catch: IOException finally { try{ bos.close(); } catch( Exception e ){} } // end finally return success; } // end decodeToFile

static Object Base64::decodeToObject (  String  encodedObject  )  [inline, static]

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 Since: 1.5 Definition at line 774 of file Base64.java. References decode(). { // Decode and gunzip if necessary byte[] objBytes = decode( encodedObject ); java.io.ByteArrayInputStream bais = null; java.io.ObjectInputStream ois = null; Object obj = null; try { bais = new java.io.ByteArrayInputStream( objBytes ); ois = new java.io.ObjectInputStream( bais ); obj = ois.readObject(); } // end try catch( java.io.IOException e ) { e.printStackTrace(); obj = null; } // end catch catch( java.lang.ClassNotFoundException e ) { e.printStackTrace(); obj = null; } // end catch finally { try{ bais.close(); } catch( Exception e ){} try{ ois.close(); } catch( Exception e ){} } // end finally return obj; } // end decodeObject

static byte [] Base64::encode3to4 (  byte[]  source, int  srcOffset, int  numSigBytes, byte[]  destination, int  destOffset )  [inline, static, private]

Encodes up to three bytes of the array source and writes the resulting four Base64 bytes to destination. The source and destination arrays can be manipulated anywhere along their length by specifying srcOffset and destOffset. This method does not check to make sure your arrays are large enough to accomodate srcOffset + 3 for the source array or destOffset + 4 for the destination array. The actual number of significant bytes in your array is given by numSigBytes. Parameters: source  the array to convert srcOffset  the index where conversion begins numSigBytes  the number of significant bytes in your array destination  the array to hold the conversion destOffset  the index where output will be put Returns: the destination array Since: 1.3 Definition at line 220 of file Base64.java. References ALPHABET, and EQUALS_SIGN. { // 1 2 3 // 01234567890123456789012345678901 Bit position // --------000000001111111122222222 Array position from threeBytes // --------| || || || | Six bit groups to index ALPHABET // >>18 >>12 >> 6 >> 0 Right shift necessary // 0x3f 0x3f 0x3f Additional AND // Create buffer with zero-padding if there are only one or two // significant bytes passed in the array. // We have to shift left 24 in order to flush out the 1's that appear // when Java treats a value as negative that is cast from a byte to an int. int inBuff = ( numSigBytes > 0 ? ((source[ srcOffset ] << 24) >>> 8) : 0 ) | ( numSigBytes > 1 ? ((source[ srcOffset + 1 ] << 24) >>> 16) : 0 ) | ( numSigBytes > 2 ? ((source[ srcOffset + 2 ] << 24) >>> 24) : 0 ); switch( numSigBytes ) { case 3: destination[ destOffset ] = ALPHABET[ (inBuff >>> 18) ]; destination[ destOffset + 1 ] = ALPHABET[ (inBuff >>> 12) & 0x3f ]; destination[ destOffset + 2 ] = ALPHABET[ (inBuff >>> 6) & 0x3f ]; destination[ destOffset + 3 ] = ALPHABET[ (inBuff ) & 0x3f ]; return destination; case 2: destination[ destOffset ] = ALPHABET[ (inBuff >>> 18) ]; destination[ destOffset + 1 ] = ALPHABET[ (inBuff >>> 12) & 0x3f ]; destination[ destOffset + 2 ] = ALPHABET[ (inBuff >>> 6) & 0x3f ]; destination[ destOffset + 3 ] = EQUALS_SIGN; return destination; case 1: destination[ destOffset ] = ALPHABET[ (inBuff >>> 18) ]; destination[ destOffset + 1 ] = ALPHABET[ (inBuff >>> 12) & 0x3f ]; destination[ destOffset + 2 ] = EQUALS_SIGN; destination[ destOffset + 3 ] = EQUALS_SIGN; return destination; default: return destination; } // end switch } // end encode3to4

static byte [] Base64::encode3to4 (  byte[]  b4, byte[]  threeBytes, int  numSigBytes )  [inline, static, private]

Encodes up to the first three bytes of array threeBytes and returns a four-byte array in Base64 notation. The actual number of significant bytes in your array is given by numSigBytes. The array threeBytes needs only be as big as numSigBytes. Code can reuse a byte array by passing a four-byte array as b4. Parameters: b4  A reusable byte array to reduce array instantiation threeBytes  the array to convert numSigBytes  the number of significant bytes in your array Returns: four byte array in Base64 notation. Since: 1.5.1 Definition at line 192 of file Base64.java. { encode3to4( threeBytes, 0, numSigBytes, b4, 0 ); return b4; } // end encode3to4

static String Base64::encodeBytes (  byte[]  source, int  off, int  len, int  options )  [inline, static]

Encodes a byte array into Base64 notation. Valid options: GZIP: gzip-compresses object before encoding it. DONT_BREAK_LINES: don't 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.DONT_BREAK_LINES ) Parameters: source  The data to convert off  Offset in array where conversion should begin len  Length of data to convert options  Specified options See also: Base64::GZIP Base64::DONT_BREAK_LINES Since: 2.0 Definition at line 444 of file Base64.java. References DONT_BREAK_LINES, ENCODE, encode3to4(), GZIP, MAX_LINE_LENGTH, NEW_LINE, and PREFERRED_ENCODING. { // Isolate options int dontBreakLines = ( options & DONT_BREAK_LINES ); int gzip = ( options & GZIP ); // Compress? if( gzip == GZIP ) { java.io.ByteArrayOutputStream baos = null; java.util.zip.GZIPOutputStream gzos = null; Base64.OutputStream b64os = null; try { // GZip -> Base64 -> ByteArray baos = new java.io.ByteArrayOutputStream(); b64os = new Base64.OutputStream( baos, ENCODE | dontBreakLines ); gzos = new java.util.zip.GZIPOutputStream( b64os ); gzos.write( source, off, len ); gzos.close(); } // end try catch( java.io.IOException e ) { e.printStackTrace(); return null; } // end catch finally { try{ gzos.close(); } catch( Exception e ){} try{ b64os.close(); } catch( Exception e ){} try{ baos.close(); } catch( Exception e ){} } // end finally // Return value according to relevant encoding. try { return new String( baos.toByteArray(), PREFERRED_ENCODING ); } // end try catch (java.io.UnsupportedEncodingException uue) { return new String( baos.toByteArray() ); } // end catch } // end if: compress // Else, don't compress. Better not to use streams at all then. else { // Convert option to boolean in way that code likes it. boolean breakLines = dontBreakLines == 0; int len43 = len * 4 / 3; byte[] outBuff = new byte[ ( len43 ) // Main 4:3 + ( (len % 3) > 0 ? 4 : 0 ) // Account for padding + (breakLines ? ( len43 / MAX_LINE_LENGTH ) : 0) ]; // New lines int d = 0; int e = 0; int len2 = len - 2; int lineLength = 0; for( ; d < len2; d+=3, e+=4 ) { encode3to4( source, d+off, 3, outBuff, e ); lineLength += 4; if( breakLines && lineLength == MAX_LINE_LENGTH ) { outBuff[e+4] = NEW_LINE; e++; lineLength = 0; } // end if: end of line } // en dfor: each piece of array if( d < len ) { encode3to4( source, d+off, len - d, outBuff, e ); e += 4; } // end if: some padding needed // Return value according to relevant encoding. try { return new String( outBuff, 0, e, PREFERRED_ENCODING ); } // end try catch (java.io.UnsupportedEncodingException uue) { return new String( outBuff, 0, e ); } // end catch } // end else: don't compress } // end encodeBytes

static String Base64::encodeBytes (  byte[]  source, int  off, int  len )  [inline, static]

Encodes a byte array into Base64 notation. Does not GZip-compress data. Parameters: source  The data to convert off  Offset in array where conversion should begin len  Length of data to convert Since: 1.4 Definition at line 415 of file Base64.java. References encodeBytes(), and NO_OPTIONS. { return encodeBytes( source, off, len, NO_OPTIONS ); } // end encodeBytes

static String Base64::encodeBytes (  byte[]  source, int  options )  [inline, static]

Encodes a byte array into Base64 notation. Valid options: GZIP: gzip-compresses object before encoding it. DONT_BREAK_LINES: don't 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.DONT_BREAK_LINES ) Parameters: source  The data to convert options  Specified options See also: Base64::GZIP Base64::DONT_BREAK_LINES Since: 2.0 Definition at line 400 of file Base64.java. References encodeBytes(). { return encodeBytes( source, 0, source.length, options ); } // end encodeBytes

static String Base64::encodeBytes (  byte[]  source  )  [inline, static]

Encodes a byte array into Base64 notation. Does not GZip-compress data. Parameters: source  The data to convert Since: 1.4 Definition at line 373 of file Base64.java. References NO_OPTIONS. { return encodeBytes( source, 0, source.length, NO_OPTIONS ); } // end encodeBytes

static String Base64::encodeFromFile (  String  filename  )  [inline, static]

Convenience method for reading a binary file and base64-encoding it. Parameters: filename  Filename for reading binary data Returns: base64-encoded string or null if unsuccessful Since: 2.1 Definition at line 946 of file Base64.java. { String encodedData = null; Base64.InputStream bis = null; try { // Set up some useful variables java.io.File file = new java.io.File( filename ); byte[] buffer = new byte[ (int)(file.length() * 1.4) ]; int length = 0; int numBytes = 0; // Open a stream bis = new Base64.InputStream( new java.io.BufferedInputStream( new java.io.FileInputStream( file ) ), Base64.ENCODE ); // Read until done while( ( numBytes = bis.read( buffer, length, 4096 ) ) >= 0 ) length += numBytes; // Save in a variable to return encodedData = new String( buffer, 0, length, Base64.PREFERRED_ENCODING ); } // end try catch( java.io.IOException e ) { System.err.println( "Error encoding from file " + filename ); } // end catch: IOException finally { try{ bis.close(); } catch( Exception e) {} } // end finally return encodedData; } // end encodeFromFile

static String Base64::encodeObject (  java.io.Serializable  serializableObject, int  options )  [inline, static]

Serializes an object and returns the Base64-encoded version of that serialized object. If the object cannot be serialized or there is another error, the method will return null. Valid options: GZIP: gzip-compresses object before encoding it. DONT_BREAK_LINES: don't break lines at 76 characters Note: Technically, this makes your encoding non-compliant. Example: encodeObject( myObj, Base64.GZIP ) or Example: encodeObject( myObj, Base64.GZIP | Base64.DONT_BREAK_LINES ) Parameters: serializableObject  The object to encode options  Specified options Returns: The Base64-encoded object See also: Base64::GZIP Base64::DONT_BREAK_LINES Since: 2.0 Definition at line 310 of file Base64.java. References DONT_BREAK_LINES, ENCODE, GZIP, and PREFERRED_ENCODING. { // Streams java.io.ByteArrayOutputStream baos = null; java.io.OutputStream b64os = null; java.io.ObjectOutputStream oos = null; java.util.zip.GZIPOutputStream gzos = null; // Isolate options int gzip = (options & GZIP); int dontBreakLines = (options & DONT_BREAK_LINES); try { // ObjectOutputStream -> (GZIP) -> Base64 -> ByteArrayOutputStream baos = new java.io.ByteArrayOutputStream(); b64os = new Base64.OutputStream( baos, ENCODE | dontBreakLines ); // GZip? if( gzip == GZIP ) { gzos = new java.util.zip.GZIPOutputStream( b64os ); oos = new java.io.ObjectOutputStream( gzos ); } // end if: gzip else oos = new java.io.ObjectOutputStream( b64os ); oos.writeObject( serializableObject ); } // end try catch( java.io.IOException e ) { e.printStackTrace(); return null; } // end catch finally { try{ oos.close(); } catch( Exception e ){} try{ gzos.close(); } catch( Exception e ){} try{ b64os.close(); } catch( Exception e ){} try{ baos.close(); } catch( Exception e ){} } // end finally // Return value according to relevant encoding. try { return new String( baos.toByteArray(), PREFERRED_ENCODING ); } // end try catch (java.io.UnsupportedEncodingException uue) { return new String( baos.toByteArray() ); } // end catch } // end encode

static String Base64::encodeObject (  java.io.Serializable  serializableObject  )  [inline, static]

Serializes an object and returns the Base64-encoded version of that serialized object. If the object cannot be serialized or there is another error, the method will return null. The object is not GZip-compressed before being encoded. Parameters: serializableObject  The object to encode Returns: The Base64-encoded object Since: 1.4 Definition at line 280 of file Base64.java. References NO_OPTIONS. { return encodeObject( serializableObject, NO_OPTIONS ); } // end encodeObject

static boolean Base64::encodeToFile (  byte[]  dataToEncode, String  filename )  [inline, static]

Convenience method for encoding data to a file. Parameters: dataToEncode  byte array of data to encode in base64 form filename  Filename for saving encoded data Returns: true if successful, false otherwise Since: 2.1 Definition at line 820 of file Base64.java. { boolean success = false; Base64.OutputStream bos = null; try { bos = new Base64.OutputStream( new java.io.FileOutputStream( filename ), Base64.ENCODE ); bos.write( dataToEncode ); success = true; } // end try catch( java.io.IOException e ) { success = false; } // end catch: IOException finally { try{ bos.close(); } catch( Exception e ){} } // end finally return success; } // end encodeToFile

---

Member Data Documentation

final byte [] Base64::_NATIVE_ALPHABET [static, private]

Initial value: { (byte)'A', (byte)'B', (byte)'C', (byte)'D', (byte)'E', (byte)'F', (byte)'G', (byte)'H', (byte)'I', (byte)'J', (byte)'K', (byte)'L', (byte)'M', (byte)'N', (byte)'O', (byte)'P', (byte)'Q', (byte)'R', (byte)'S', (byte)'T', (byte)'U', (byte)'V', (byte)'W', (byte)'X', (byte)'Y', (byte)'Z', (byte)'a', (byte)'b', (byte)'c', (byte)'d', (byte)'e', (byte)'f', (byte)'g', (byte)'h', (byte)'i', (byte)'j', (byte)'k', (byte)'l', (byte)'m', (byte)'n', (byte)'o', (byte)'p', (byte)'q', (byte)'r', (byte)'s', (byte)'t', (byte)'u', (byte)'v', (byte)'w', (byte)'x', (byte)'y', (byte)'z', (byte)'0', (byte)'1', (byte)'2', (byte)'3', (byte)'4', (byte)'5', (byte)'6', (byte)'7', (byte)'8', (byte)'9', (byte)'+', (byte)'/' } Definition at line 94 of file Base64.java.

final byte [] Base64::ALPHABET [static, private]

The 64 valid Base64 values. Definition at line 93 of file Base64.java.

final byte [] Base64::DECODABET [static, private]

Initial value: { -9,-9,-9,-9,-9,-9,-9,-9,-9, -5,-5, -9,-9, -5, -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, -9,-9,-9,-9,-9, -5, -9,-9,-9,-9,-9,-9,-9,-9,-9,-9, 62, -9,-9,-9, 63, 52,53,54,55,56,57,58,59,60,61, -9,-9,-9, -1, -9,-9,-9, 0,1,2,3,4,5,6,7,8,9,10,11,12,13, 14,15,16,17,18,19,20,21,22,23,24,25, -9,-9,-9,-9,-9,-9, 26,27,28,29,30,31,32,33,34,35,36,37,38, 39,40,41,42,43,44,45,46,47,48,49,50,51, -9,-9,-9,-9 } Translates a Base64 value to either its 6-bit reconstruction value or a negative number indicating some other meaning. Definition at line 128 of file Base64.java.

final int Base64::DECODE = 0 [static]

Specify decoding. Definition at line 62 of file Base64.java.

final int Base64::DONT_BREAK_LINES = 8 [static]

Don't break lines when encoding (violates strict Base64 specification) Definition at line 70 of file Base64.java.

final int Base64::ENCODE = 1 [static]

Specify encoding. Definition at line 58 of file Base64.java.

final byte Base64::EQUALS_SIGN = (byte)'=' [static, private]

The equals sign (=) as a byte. Definition at line 81 of file Base64.java.

final byte Base64::EQUALS_SIGN_ENC = -1 [static, private]

Definition at line 166 of file Base64.java.

final int Base64::GZIP = 2 [static]

Specify that data should be gzip-compressed. Definition at line 66 of file Base64.java.

final int Base64::MAX_LINE_LENGTH = 76 [static, private]

Maximum line length (76) of Base64 output. Definition at line 77 of file Base64.java.

final byte Base64::NEW_LINE = (byte)'\n' [static, private]

The new line character ( ) as a byte. Definition at line 85 of file Base64.java.

final int Base64::NO_OPTIONS = 0 [static]

No options specified. Value is zero. Definition at line 55 of file Base64.java.

final String Base64::PREFERRED_ENCODING = "UTF-8" [static, private]

Preferred encoding. Definition at line 89 of file Base64.java.

final byte Base64::WHITE_SPACE_ENC = -5 [static, private]

Definition at line 165 of file Base64.java.

---

The documentation for this class was generated from the following file:

• Base64.java

---