org.pdfbox.io
Class ASCII85InputStream

java.lang.Object
  extended byjava.io.InputStream
      extended byjava.io.FilterInputStream
          extended byorg.pdfbox.io.ASCII85InputStream

public class ASCII85InputStream
extends FilterInputStream

This class represents an ASCII85 stream.

Version:
$Revision: 1.6 $
Author:
Ben Litchfield

Field Summary
 
Fields inherited from class java.io.FilterInputStream
in
 
Constructor Summary
ASCII85InputStream(InputStream is)
          Constructor.
 
Method Summary
 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.

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.

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.

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

markSupported

public boolean markSupported()
non supported interface methods.

Returns:
False always.

skip

public long skip(long nValue)
Unsupported.

Parameters:
nValue - ignored.
Returns:
Always zero.

available

public int available()
Unsupported.

Returns:
Always zero.

mark

public void mark(int readlimit)
Unsupported.

Parameters:
readlimit - ignored.

reset

public void reset()
           throws IOException
Unsupported.

Throws:
IOException - telling that this is an unsupported action.