org.apache.oodt.commons.io

Class Base64DecodingInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.apache.oodt.commons.io.Base64DecodingInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class Base64DecodingInputStream
extends FilterInputStream

An input stream that decodes its data from the RFC-1512 base 64 format. Wrap this input stream around another input stream, and all the bytes will be converted from their base-64 format when you read from it.

Author:

Kelly

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
Base64DecodingInputStream(InputStream inputStream) Construct a base-64 decoding input stream.

Method Summary

Modifier and Type	Method and Description
int	available() Return bytes available for reading or skipping without blocking.
void	close() Close this stream.
int	read() Read the next byte.
int	read(byte[] b, int offset, int length) Read a bunch of bytes.
long	skip(long n) Skip bytes.

Methods inherited from class java.io.FilterInputStream

mark, markSupported, read, reset

Methods inherited from class java.lang.Object

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

Constructor Detail

Base64DecodingInputStream

public Base64DecodingInputStream(InputStream inputStream)

Construct a base-64 decoding input stream.

Parameters:

inputStream - The input stream to decode.

Method Detail

read

public int read()
         throws IOException

Read the next byte. Decode more base-64 data and return the next decoded byte.

Overrides:

read in class FilterInputStream

Returns:

The byte, or -1 on end of stream.

Throws:

IOException - If an I/O error occurs.

read

public int read(byte[] b,
                int offset,
                int length)
         throws IOException

Read a bunch of bytes. This decodes base-64 data from the underlying stream and puts the result into the given array.

Overrides:

read in class FilterInputStream

Parameters:

b - The buffer to fill with decoded base-64 data.

offset - Where in the buffer to start filling.

length - How many bytes to fill.

Returns:

The actual number of decoded bytes.

Throws:

IOException - If an I/O error occurs.

skip

public long skip(long n)
          throws IOException

Skip bytes. This method skips and discards n decoded bytes on the input stream.

Overrides:

skip in class FilterInputStream

Parameters:

n - Number of bytes to skip.

Returns:

Actual number of bytes skipped.

Throws:

IOException - If an I/O error occurs.

available

public int available()
              throws IOException

Return bytes available for reading or skipping without blocking.

Overrides:

available in class FilterInputStream

Returns:

The number of bytes that can be read from this stream or skipped over on the stream without blocking.

Throws:

IOException - If an I/O error occurs.

close

public void close()
           throws IOException

Close this stream.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FilterInputStream

Throws:

IOException - If an I/O error occurs.