Base64 (spanner-jdbc 0.23 API)

java.lang.Object
- nl.topicus.jdbc.util.Base64

```
public class Base64
extends Object
```
. This implementation is based on the implementation of PostgreSQL. PostgreSQL is released under the PostgreSQL License, a liberal Open Source license, similar to the BSD or MIT licenses. PostgreSQL Database Management System (formerly known as Postgres, then as Postgres95) Portions Copyright (c) 1996-2017, The PostgreSQL Global Development Group Portions Copyright (c) 1994, The Regents of the University of California IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. This code is a stripped down version of Robert Harder's Public Domain Base64 implementation. GZIP support, InputStream and OutputStream stuff and some unneeded encode/decode methods have been removed. -- Original comments follow -- 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.
Version:

2.1

Author:

Robert Harder, rob@iharder.net

Field Summary

Fields
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`	`NO_OPTIONS` No options specified.

Method Summary

All Methods Static Methods Concrete Methods
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 s)` Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
`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.

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.
    
    See Also:
    
    Constant Field Values
  - DECODE
```
public static final int DECODE
```
    Specify decoding.
    
    See Also:
    
    Constant Field Values
  - DONT_BREAK_LINES
```
public static final int DONT_BREAK_LINES
```
    Don't break lines when encoding (violates strict Base64 specification)
    
    See Also:
    
    Constant Field Values
- Method Detail
  - encodeBytes
```
public static String encodeBytes(byte[] source)
```
    Encodes a byte array into Base64 notation. Does not GZip-compress data.
    
    Parameters:
    
    source - The data to convert
    
    Returns:
    
    Base64 notation of input data
    
    Since:
    
    1.4
  - encodeBytes
```
public static String encodeBytes(byte[] source,
                                 int options)
```
    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
    
    Returns:
    
    Base64 notation
    
    Since:
    
    2.0
    
    See Also:
    
    DONT_BREAK_LINES
  - encodeBytes
```
public static String encodeBytes(byte[] source,
                                 int off,
                                 int len)
```
    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
    
    Returns:
    
    Base64 notation
    
    Since:
    
    1.4
  - encodeBytes
```
public static String encodeBytes(byte[] source,
                                 int off,
                                 int len,
                                 int options)
```
    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
    
    Returns:
    
    Base64 notation
    
    Since:
    
    2.0
    
    See Also:
    
    DONT_BREAK_LINES
  - decode
```
public static byte[] decode(byte[] source,
                            int off,
                            int len)
```
    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
  - decode
```
public static byte[] decode(String s)
```
    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

Class Base64

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_OPTIONS

ENCODE

DECODE

DONT_BREAK_LINES

Method Detail

encodeBytes

encodeBytes

encodeBytes

encodeBytes

decode

decode