BASE64
Date: 2011-09-29

概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## junkutil.crypt
クラス BASE64

    java.lang.Object
      junkutil.crypt.BASE64

    public class BASE64

extends java.lang.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 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 int` | `GZIP` Specify that data should be gzip-compressed in second bit.
`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)` Low-level access to decoding ASCII characters in the form of a byte array.
`static byte[]` | `decode(byte[] source, int off, int len, int options)` Low-level access to decoding ASCII characters in the form of a byte array.
`static byte[]` | `decode(java.lang.String s)` Decodes data from BASE64 notation, automatically detecting gzip-compressed data and decompressing it.
`static byte[]` | `decode(java.lang.String s, int options)` Decodes data from BASE64 notation, automatically detecting gzip-compressed data and decompressing it.
`static void` | `decodeFileToFile(java.lang.String infile, java.lang.String outfile)` Reads `infile` and decodes it to `outfile`.
`static byte[]` | `decodeFromFile(java.lang.String filename)` Convenience method for reading a base64-encoded file and decoding it.
`static void` | `decodeToFile(java.lang.String dataToDecode, java.lang.String filename)` Convenience method for decoding 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.Object` | `decodeToObject(java.lang.String encodedObject, int options, java.lang.ClassLoader loader)` Attempts to decode BASE64 data and deserialize a Java Object within.
`static void` | `encode(java.nio.ByteBuffer raw, java.nio.ByteBuffer encoded)` Performs BASE64 encoding on the `raw` ByteBuffer, writing it to the `encoded` ByteBuffer.
`static void` | `encode(java.nio.ByteBuffer raw, java.nio.CharBuffer encoded)` Performs BASE64 encoding on the `raw` ByteBuffer, writing it to the `encoded` CharBuffer.
`static java.lang.String` | `encodeBytes(byte[] source)` Encodes a byte array into BASE64 notation.
`static java.lang.String` | `encodeBytes(byte[] source, int options)` 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, int options)` 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[] source, int off, int len, int options)` Similar to `encodeBytes(byte[], int, int, int)` but returns a byte array instead of instantiating a String.
`static void` | `encodeFileToFile(java.lang.String infile, java.lang.String outfile)` Reads `infile` and encodes it to `outfile`.
`static java.lang.String` | `encodeFromFile(java.lang.String filename)` Convenience method for reading a binary file and base64-encoding it.
`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, int options)` Serializes an object and returns the BASE64-encoded version of that serialized object.
`static void` | `encodeToFile(byte[] dataToEncode, java.lang.String filename)` Convenience method for encoding data to a file.

クラス 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 in first bit. Value is one.

  関連項目:
    定数フィールド値

### DECODE

    public static final int DECODE

  Specify decoding in first bit. Value is zero.

  関連項目:
    定数フィールド値

### GZIP

    public static final int GZIP

  Specify that data should be gzip-compressed in second bit. Value is two.

  関連項目:
    定数フィールド値

### DONT_GUNZIP

    public static final int DONT_GUNZIP

  Specify that gzipped data should not be automatically gunzipped.

  関連項目:
    定数フィールド値

### DO_BREAK_LINES

    public static final int DO_BREAK_LINES

  Do break lines when encoding. Value is 8.

  関連項目:
    定数フィールド値

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

  関連項目:
    定数フィールド値

メソッドの詳細

### encode

    public static void encode(java.nio.ByteBuffer raw,
                              java.nio.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`.

  パラメータ:
    `raw` - input buffer
    `encoded` - output buffer
  導入されたバージョン:
    2.3

### encode

    public static void encode(java.nio.ByteBuffer raw,
                              java.nio.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`.

  パラメータ:
    `raw` - input buffer
    `encoded` - output buffer
  導入されたバージョン:
    2.3

### encodeObject

    public static java.lang.String encodeObject(java.io.Serializable serializableObject)
                                         throws java.io.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 java.io.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.

  パラメータ:
    `serializableObject` - The object to encode
  戻り値:
    The BASE64-encoded object
  例外:
    `java.io.IOException` - if there is an error
    `java.lang.NullPointerException` - if serializedObject is null
  導入されたバージョン:
    1.4

### encodeObject

    public static java.lang.String encodeObject(java.io.Serializable serializableObject,
                                                int options)
                                         throws java.io.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 java.io.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 )`

  パラメータ:
    `serializableObject` - The object to encode
    `options` - Specified options
  戻り値:
    The BASE64-encoded object
  例外:
    `java.io.IOException` - if there is an error
  導入されたバージョン:
    2.0
  関連項目:
    `GZIP`, `DO_BREAK_LINES`

### encodeBytes

    public static java.lang.String encodeBytes(byte[] source)

  Encodes a byte array into BASE64 notation. Does not GZip-compress data.

  パラメータ:
    `source` - The data to convert
  戻り値:
    The data in BASE64-encoded form
  例外:
    `java.lang.NullPointerException` - if source array is null
  導入されたバージョン:
    1.4

### encodeBytes

    public static java.lang.String encodeBytes(byte[] source,
                                               int options)
                                        throws java.io.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 java.io.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.

  パラメータ:
    `source` - The data to convert
    `options` - Specified options
  戻り値:
    The BASE64-encoded data as a String
  例外:
    `java.io.IOException` - if there is an error
    `java.lang.NullPointerException` - if source array is null
  導入されたバージョン:
    2.0
  関連項目:
    `GZIP`, `DO_BREAK_LINES`

### encodeBytes

    public static java.lang.String encodeBytes(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 java.io.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.

  パラメータ:
    `source` - The data to convert
    `off` - Offset in array where conversion should begin
    `len` - Length of data to convert
  戻り値:
    The BASE64-encoded data as a String
  例外:
    `java.lang.NullPointerException` - if source array is null
    `java.lang.IllegalArgumentException` - if source array, offset, or length are invalid
  導入されたバージョン:
    1.4

### encodeBytes

    public static java.lang.String encodeBytes(byte[] source,
                                               int off,
                                               int len,
                                               int options)
                                        throws java.io.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 java.io.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.

  パラメータ:
    `source` - The data to convert
    `off` - Offset in array where conversion should begin
    `len` - Length of data to convert
    `options` - Specified options
  戻り値:
    The BASE64-encoded data as a String
  例外:
    `java.io.IOException` - if there is an error
    `java.lang.NullPointerException` - if source array is null
    `java.lang.IllegalArgumentException` - if source array, offset, or length are invalid
  導入されたバージョン:
    2.0
  関連項目:
    `GZIP`, `DO_BREAK_LINES`

### encodeBytesToBytes

    public static byte[] encodeBytesToBytes(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.

  パラメータ:
    `source` - The data to convert
  戻り値:
    The BASE64-encoded data as a byte[] (of ASCII characters)
  例外:
    `java.lang.NullPointerException` - if source array is null
  導入されたバージョン:
    2.3.1

### encodeBytesToBytes

    public static byte[] encodeBytesToBytes(byte[] source,
                                            int off,
                                            int len,
                                            int options)
                                     throws java.io.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.

  パラメータ:
    `source` - The data to convert
    `off` - Offset in array where conversion should begin
    `len` - Length of data to convert
    `options` - Specified options
  戻り値:
    The BASE64-encoded data as a String
  例外:
    `java.io.IOException` - if there is an error
    `java.lang.NullPointerException` - if source array is null
    `java.lang.IllegalArgumentException` - if source array, offset, or length are invalid
  導入されたバージョン:
    2.3.1
  関連項目:
    `GZIP`, `DO_BREAK_LINES`

### decode

    public static byte[] decode(byte[] source)
                         throws java.io.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.

  パラメータ:
    `source` - The BASE64 encoded data
  戻り値:
    decoded data
  例外:
    `java.io.IOException`
  導入されたバージョン:
    2.3.1

### decode

    public static byte[] decode(byte[] source,
                                int off,
                                int len,
                                int options)
                         throws java.io.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.

  パラメータ:
    `source` - The BASE64 encoded data
    `off` - The offset of where to begin decoding
    `len` - The length of characters to decode
    `options` - Can specify options such as alphabet type to use
  戻り値:
    decoded data
  例外:
    `java.io.IOException` - If bogus characters exist in source data
  導入されたバージョン:
    1.3

### decode

    public static byte[] decode(java.lang.String s)
                         throws java.io.IOException

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

  パラメータ:
    `s` - the string to decode
  戻り値:
    the decoded data
  例外:
    `java.io.IOException` - If there is a problem
  導入されたバージョン:
    1.4

### decode

    public static byte[] decode(java.lang.String s,
                                int options)
                         throws java.io.IOException

  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
  例外:
    `java.io.IOException` - if there is an error
    `java.lang.NullPointerException` - if `s` is null
  導入されたバージョン:
    1.4

### decodeToObject

    public static java.lang.Object decodeToObject(java.lang.String encodedObject)
                                           throws java.io.IOException,
                                                  java.lang.ClassNotFoundException

  Attempts to decode BASE64 data and deserialize a Java Object within. Returns `null` if there was an error.

  パラメータ:
    `encodedObject` - The BASE64 data to decode
  戻り値:
    The decoded and deserialized object
  例外:
    `java.lang.NullPointerException` - if encodedObject is null
    `java.io.IOException` - if there is a general error
    `java.lang.ClassNotFoundException` - if the decoded object is of a class that cannot be found by the JVM
  導入されたバージョン:
    1.5

### decodeToObject

    public static java.lang.Object decodeToObject(java.lang.String encodedObject,
                                                  int options,
                                                  java.lang.ClassLoader loader)
                                           throws java.io.IOException,
                                                  java.lang.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.

  パラメータ:
    `encodedObject` - The BASE64 data to decode
    `options` - Various parameters related to decoding
    `loader` - Optional class loader to use in deserializing classes.
  戻り値:
    The decoded and deserialized object
  例外:
    `java.lang.NullPointerException` - if encodedObject is null
    `java.io.IOException` - if there is a general error
    `java.lang.ClassNotFoundException` - if the decoded object is of a class that cannot be found by the JVM
  導入されたバージョン:
    2.3.4

### encodeToFile

    public static void encodeToFile(byte[] dataToEncode,
                                    java.lang.String filename)
                             throws java.io.IOException

  Convenience method for encoding data to a file.

  As of v 2.3, if there is a error, the method will throw an java.io.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.

  パラメータ:
    `dataToEncode` - byte array of data to encode in base64 form
    `filename` - Filename for saving encoded data
  例外:
    `java.io.IOException` - if there is an error
    `java.lang.NullPointerException` - if dataToEncode is null
  導入されたバージョン:
    2.1

### decodeToFile

    public static void decodeToFile(java.lang.String dataToDecode,
                                    java.lang.String filename)
                             throws java.io.IOException

  Convenience method for decoding data to a file.

  As of v 2.3, if there is a error, the method will throw an java.io.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.

  パラメータ:
    `dataToDecode` - BASE64-encoded data as a string
    `filename` - Filename for saving decoded data
  例外:
    `java.io.IOException` - if there is an error
  導入されたバージョン:
    2.1

### decodeFromFile

    public static byte[] decodeFromFile(java.lang.String filename)
                                 throws java.io.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 java.io.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.

  パラメータ:
    `filename` - Filename for reading encoded data
  戻り値:
    decoded byte array
  例外:
    `java.io.IOException` - if there is an error
  導入されたバージョン:
    2.1

### encodeFromFile

    public static java.lang.String encodeFromFile(java.lang.String filename)
                                           throws java.io.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 java.io.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.

  パラメータ:
    `filename` - Filename for reading binary data
  戻り値:
    base64-encoded string
  例外:
    `java.io.IOException` - if there is an error
  導入されたバージョン:
    2.1

### encodeFileToFile

    public static void encodeFileToFile(java.lang.String infile,
                                        java.lang.String outfile)
                                 throws java.io.IOException

  Reads `infile` and encodes it to `outfile`.

  パラメータ:
    `infile` - Input file
    `outfile` - Output file
  例外:
    `java.io.IOException` - if there is an error
  導入されたバージョン:
    2.2

### decodeFileToFile

    public static void decodeFileToFile(java.lang.String infile,
                                        java.lang.String outfile)
                                 throws java.io.IOException

  Reads `infile` and decodes it to `outfile`.

  パラメータ:
    `infile` - Input file
    `outfile` - Output file
  例外:
    `java.io.IOException` - if there is an error
  導入されたバージョン:
    2.2

概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド