Base64InputStream (Apache Commons Codec 1.10 API)

org.apache.commons.codec.binary

## Class Base64InputStream

- java.lang.Object
- - java.io.InputStream
  - - java.io.FilterInputStream
    - - org.apache.commons.codec.binary.BaseNCodecInputStream
      - - org.apache.commons.codec.binary.Base64InputStream

- All Implemented Interfaces:
    Closeable, AutoCloseable

      public class Base64InputStream
      extends BaseNCodecInputStream

  Provides Base64 encoding and decoding in a streaming fashion (unlimited size). When encoding the default lineLength is 76 characters and the default lineEnding is CRLF, but these can be overridden by using the appropriate constructor.

  The default behaviour of the Base64InputStream is to DECODE, whereas the default behaviour of the Base64OutputStream is to ENCODE, but this behaviour can be overridden by using a different constructor.

  This class implements section 6.8. Base64 Content-Transfer-Encoding from RFC 2045 Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies by Freed and Borenstein.

  Since this class operates directly on byte streams, and not character streams, it is hard-coded to only encode/decode character encodings which are compatible with the lower 127 ASCII chart (ISO-8859-1, Windows-1252, UTF-8, etc).

  Since:
    1.4
  Version:
    $Id: Base64InputStream.java 1634429 2014-10-27 01:08:36Z ggregory $
  See Also:
    RFC 2045

- - ### Field Summary

    - ### Fields inherited from class java.io.FilterInputStream

      `in`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `Base64InputStream(InputStream in)` Creates a Base64InputStream such that all data read is Base64-decoded from the original provided InputStream.
    `Base64InputStream(InputStream in, boolean doEncode)` Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original provided InputStream.
    `Base64InputStream(InputStream in, boolean doEncode, int lineLength, byte[] lineSeparator)` Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original provided InputStream.

  - ### Method Summary

    - ### Methods inherited from class org.apache.commons.codec.binary.BaseNCodecInputStream

      `available, mark, markSupported, read, read, reset, skip`

    - ### Methods inherited from class java.io.FilterInputStream

      `close, read`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### Base64InputStream

          public Base64InputStream(InputStream in)

      Creates a Base64InputStream such that all data read is Base64-decoded from the original provided InputStream.
      Parameters:
        `in` - InputStream to wrap.

    - #### Base64InputStream

          public Base64InputStream(InputStream in,
                           boolean doEncode)

      Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original provided InputStream.
      Parameters:
        `in` - InputStream to wrap.
        `doEncode` - true if we should encode all data read from us, false if we should decode.

    - #### Base64InputStream

          public Base64InputStream(InputStream in,
                           boolean doEncode,
                           int lineLength,
                           byte[] lineSeparator)

      Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original provided InputStream.
      Parameters:
        `in` - InputStream to wrap.
        `doEncode` - true if we should encode all data read from us, false if we should decode.
        `lineLength` - If doEncode is true, each line of encoded data will contain lineLength characters (rounded down to nearest multiple of 4). If lineLength <= 0, the encoded data is not divided into lines. If doEncode is false, lineLength is ignored.
        `lineSeparator` - If doEncode is true, each line of encoded data will be terminated with this byte sequence (e.g. \r\n). If lineLength <= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.

Copyright © 2002–2014 The Apache Software Foundation. All rights reserved.