Package com.helger.commons.base64

Class Base64InputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.helger.commons.io.stream.WrappedInputStream

com.helger.commons.base64.Base64InputStream

All Implemented Interfaces:

Closeable, AutoCloseable

@NotThreadSafe
public class Base64InputStream
extends WrappedInputStream

A Base64InputStream will read data from another InputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.

Since:

1.3

See Also:

Base64

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
Base64InputStream(InputStream pin)	Constructs a Base64InputStream in DECODE mode.
Base64InputStream(InputStream aIS, int nOptions)	Constructs a Base64InputStream in either ENCODE or DECODE mode.

Method Summary

Modifier and Type	Method	Description
int	read()	Reads enough of the input stream to convert to/from Base64 and returns the next byte.
int	read(byte[] aDest, int nOfs, int nLen)	Calls read() repeatedly until the end of stream is reached or len bytes are read.

Methods inherited from class com.helger.commons.io.stream.WrappedInputStream

getWrappedInputStream, toString

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, read, reset, skip

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Detail

Base64InputStream

public Base64InputStream(@Nonnull
                         InputStream pin)

Constructs a Base64InputStream in DECODE mode.

Parameters:

pin - the InputStream from which to read data.

Since:

1.3

Base64InputStream

public Base64InputStream(@Nonnull
                         InputStream aIS,
                         int nOptions)

Constructs a Base64InputStream in either ENCODE or DECODE mode.

Valid options:

   ENCODE or DECODE: Encode or Decode as data is read.
   DO_BREAK_LINES: break lines at 76 characters
     (only meaningful when encoding)
 

Example: new Base64.InputStream( in, Base64.DECODE )

Parameters:

aIS - the InputStream from which to read data.

nOptions - Specified options

Since:

2.0

See Also:

Base64.ENCODE, Base64.DECODE, Base64.DO_BREAK_LINES

Method Detail

read

public int read()
         throws IOException

Reads enough of the input stream to convert to/from Base64 and returns the next byte.

Overrides:

read in class FilterInputStream

Returns:

next byte

Throws:

IOException

Since:

1.3

read

public int read(@Nonnull
                byte[] aDest,
                @Nonnegative
                int nOfs,
                @Nonnegative
                int nLen)
         throws IOException

Calls read() repeatedly until the end of stream is reached or len bytes are read. Returns number of bytes read into array or -1 if end of stream is encountered.

Overrides:

read in class FilterInputStream

Parameters:

aDest - array to hold values

nOfs - offset for array

nLen - max number of bytes to read into array

Returns:

bytes read into array or -1 if end of stream is encountered.

Throws:

IOException

Since:

1.3