org.apache.pdfbox.io

Class ASCII85InputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.apache.pdfbox.io.ASCII85InputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class ASCII85InputStream
extends FilterInputStream

This class represents an ASCII85 stream.

Author:

Ben Litchfield

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
ASCII85InputStream(InputStream is) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	available() Unsupported.
void	close() This will close the underlying stream and release any resources.
void	mark(int readlimit) Unsupported.
boolean	markSupported() non supported interface methods.
int	read() This will read the next byte from the stream.
int	read(byte[] data, int offset, int len) This will read a chunk of data.
void	reset() Unsupported.
long	skip(long nValue) Unsupported.

Methods inherited from class java.io.FilterInputStream

read

Methods inherited from class java.lang.Object

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

Constructor Detail

ASCII85InputStream

public ASCII85InputStream(InputStream is)

Constructor.

Parameters:

is - The input stream to actually read from.

Method Detail

read

public final int read()
               throws IOException

This will read the next byte from the stream.

Overrides:

read in class FilterInputStream

Returns:

The next byte read from the stream.

Throws:

IOException - If there is an error reading from the wrapped stream.

read

public final int read(byte[] data,
       int offset,
       int len)
               throws IOException

This will read a chunk of data.

Overrides:

read in class FilterInputStream

Parameters:

data - The buffer to write data to.

offset - The offset into the data stream.

len - The number of byte to attempt to read.

Returns:

The number of bytes actually read.

Throws:

IOException - If there is an error reading data from the underlying stream.

close

public void close()
           throws IOException

This will close the underlying stream and release any resources.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FilterInputStream

Throws:

IOException - If there is an error closing the underlying stream.

markSupported

public boolean markSupported()

non supported interface methods.

Overrides:

markSupported in class FilterInputStream

Returns:

False always.

skip

public long skip(long nValue)

Unsupported.

Overrides:

skip in class FilterInputStream

Parameters:

nValue - ignored.

Returns:

Always zero.

available

public int available()

Unsupported.

Overrides:

available in class FilterInputStream

Returns:

Always zero.

mark

public void mark(int readlimit)

Unsupported.

Overrides:

mark in class FilterInputStream

Parameters:

readlimit - ignored.

reset

public void reset()
           throws IOException

Unsupported.

Overrides:

reset in class FilterInputStream

Throws:

IOException - telling that this is an unsupported action.