Base64 (commons-tool 2.0.10 API)

java.lang.Object
- cn.aotcloud.codecs.Base64

```
public class Base64
extends Object
```

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`Base64.InputStream` A `Base64.InputStream` will read data from another `java.io.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 `java.io.OutputStream`, given in the constructor, and encode/decode to/from Base64 notation on the fly.

字段概要

字段
限定符和类型	字段和说明
`static int`	`DECODE` Specify decoding.
`static int`	`DONT_BREAK_LINES` Don't break lines when encoding (violates strict Base64 specification)
`static String`	`ENABLE_UNSAFE_SERIALIZATION` System property name that must be set to true in order to invoke `Base64.decodeToObject()`.
`static int`	`ENCODE` Specify encoding.
`static int`	`GZIP` Specify that data should be gzip-compressed.
`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 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.

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static byte[]`	`decode(byte[] source, int off, int len, int options)` 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 byte[]`	`decode(String s, int options)` Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
`static boolean`	`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 boolean`	`decodeToFile(String dataToDecode, String filename)` Convenience method for decoding data to a file.
`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 boolean`	`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 boolean`	`encodeToFile(byte[] dataToEncode, String filename)` Convenience method for encoding data to a file.
`static void`	`main(String[] args)` Encodes or decodes two files from the command line; feel free to delete this method (in fact you probably should) if you're embedding this code into a larger program.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - NO_OPTIONS
```
public static final int NO_OPTIONS
```
    No options specified. Value is zero.
    
    另请参阅:
    
    常量字段值
  - ENCODE
```
public static final int ENCODE
```
    Specify encoding.
    
    另请参阅:
    
    常量字段值
  - DECODE
```
public static final int DECODE
```
    Specify decoding.
    
    另请参阅:
    
    常量字段值
  - GZIP
```
public static final int GZIP
```
    Specify that data should be gzip-compressed.
    
    另请参阅:
    
    常量字段值
  - DONT_BREAK_LINES
```
public static final int DONT_BREAK_LINES
```
    Don't break lines when encoding (violates strict Base64 specification)
    
    另请参阅:
    
    常量字段值
  - 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.
    
    另请参阅:
    
    常量字段值
  - ORDERED
```
public static final int ORDERED
```
    Encode using the special "ordered" dialect of Base64 described here: http://www.faqs.org/qa/rfcc-1940.html.
    
    另请参阅:
    
    常量字段值
  - ENABLE_UNSAFE_SERIALIZATION
```
public static final String ENABLE_UNSAFE_SERIALIZATION
```
    System property name that must be set to true in order to invoke Base64.decodeToObject().
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - main
```
public static final void main(String[] args)
```
    Encodes or decodes two files from the command line; feel free to delete this method (in fact you probably should) if you're embedding this code into a larger program.
    
    参数:
    
    args -
  - encodeBytes
```
public static String encodeBytes(byte[] source)
```
    Encodes a byte array into Base64 notation. Does not GZip-compress data.
    
    参数:
    
    source - The data to convert
    
    返回:
    
    The Base64-encoded resulting string
    
    从以下版本开始:
    
    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 )
    参数:
    
    source - The data to convert
    
    options - Specified options
    
    返回:
    
    The Base64-encoded resulting string
    
    从以下版本开始:
    
    2.0
    
    另请参阅:
    
    GZIP, 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.
    
    参数:
    
    source - The data to convert
    
    off - Offset in array where conversion should begin
    
    len - Length of data to convert
    
    返回:
    
    The Base64-encoded resulting string
    
    从以下版本开始:
    
    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 )
    参数:
    
    source - The data to convert
    
    off - Offset in array where conversion should begin
    
    len - Length of data to convert
    
    options - alphabet type is pulled from this (standard, url-safe, ordered)
    
    返回:
    
    The Base64-encoded resulting string
    
    从以下版本开始:
    
    2.0
    
    另请参阅:
    
    GZIP, DONT_BREAK_LINES
  - decode
```
public static byte[] decode(byte[] source,
                            int off,
                            int len,
                            int options)
```
    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.
    
    参数:
    
    source - The Base64 encoded data
    
    off - The offset of where to begin decoding
    
    len - The length of characters to decode
    
    options -
    
    返回:
    
    decoded data
    
    从以下版本开始:
    
    1.3
  - decode
```
public static byte[] decode(String s)
```
    Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
    
    参数:
    
    s - the string to decode
    
    返回:
    
    the decoded data
    
    从以下版本开始:
    
    1.4
  - decode
```
public static byte[] decode(String s,
                            int options)
```
    Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
    
    参数:
    
    s - the string to decode
    
    options - encode options such as URL_SAFE
    
    返回:
    
    the decoded data
    
    从以下版本开始:
    
    1.4
  - encodeToFile
```
public static boolean encodeToFile(byte[] dataToEncode,
                                   String filename)
```
    Convenience method for encoding data to a file.
    
    参数:
    
    dataToEncode - byte array of data to encode in base64 form
    
    filename - Filename for saving encoded data
    
    返回:
    
    true if successful, false otherwise
    
    从以下版本开始:
    
    2.1
  - decodeToFile
```
public static boolean decodeToFile(String dataToDecode,
                                   String filename)
```
    Convenience method for decoding data to a file.
    
    参数:
    
    dataToDecode - Base64-encoded data as a string
    
    filename - Filename for saving decoded data
    
    返回:
    
    true if successful, false otherwise
    
    从以下版本开始:
    
    2.1
  - decodeFromFile
```
public static byte[] decodeFromFile(String filename)
```
    Convenience method for reading a base64-encoded file and decoding it.
    
    参数:
    
    filename - Filename for reading encoded data
    
    返回:
    
    decoded byte array or null if unsuccessful
    
    从以下版本开始:
    
    2.1
  - encodeFromFile
```
public static String encodeFromFile(String filename)
```
    Convenience method for reading a binary file and base64-encoding it.
    
    参数:
    
    filename - Filename for reading binary data
    
    返回:
    
    base64-encoded string or null if unsuccessful
    
    从以下版本开始:
    
    2.1
  - encodeFileToFile
```
public static boolean encodeFileToFile(String infile,
                                       String outfile)
```
    Reads infile and encodes it to outfile.
    
    参数:
    
    infile - Input file
    
    outfile - Output file
    
    返回:
    
    true if the operation is successful
    
    从以下版本开始:
    
    2.2
  - decodeFileToFile
```
public static boolean decodeFileToFile(String infile,
                                       String outfile)
```
    Reads infile and decodes it to outfile.
    
    参数:
    
    infile - Input file
    
    outfile - Output file
    
    返回:
    
    true if the operation is successful
    
    从以下版本开始:
    
    2.2

类 Base64

嵌套类概要

字段概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

NO_OPTIONS

ENCODE

DECODE

GZIP

DONT_BREAK_LINES

URL_SAFE

ORDERED

ENABLE_UNSAFE_SERIALIZATION

方法详细资料

main

encodeBytes

encodeBytes

encodeBytes

encodeBytes

decode

decode

decode

encodeToFile

decodeToFile

decodeFromFile

encodeFromFile

encodeFileToFile

decodeFileToFile