org.apache.commons.codec.binary
Class BaseNCodecInputStream

java.lang.Object
  extended by java.io.InputStream
      extended by java.io.FilterInputStream
          extended by org.apache.commons.codec.binary.BaseNCodecInputStream
All Implemented Interfaces:
Closeable
Direct Known Subclasses:
Base32InputStream, Base64InputStream

public class BaseNCodecInputStream
extends FilterInputStream

Abstract superclass for Base-N input streams.

Since:
1.5
Version:
$Id: BaseNCodecInputStream.html 889935 2013-12-11 05:05:13Z ggregory $

Field Summary
 
Fields inherited from class java.io.FilterInputStream
in
 
Constructor Summary
protected BaseNCodecInputStream(InputStream in, BaseNCodec baseNCodec, boolean doEncode)
           
 
Method Summary
 int available()
          
 void mark(int readLimit)
          Marks the current position in this input stream.
 boolean markSupported()
          
 int read()
          Reads one byte from this input stream.
 int read(byte[] b, int offset, int len)
          Attempts to read len bytes into the specified b array starting at offset from this InputStream.
 void reset()
          Repositions this stream to the position at the time the mark method was last called on this input stream.
 long skip(long n)
          
 
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

BaseNCodecInputStream

protected BaseNCodecInputStream(InputStream in,
                                BaseNCodec baseNCodec,
                                boolean doEncode)
Method Detail

available

public int available()
              throws IOException

Overrides:
available in class FilterInputStream
Returns:
0 if the InputStream has reached EOF, 1 otherwise
Throws:
IOException
Since:
1.7

mark

public void mark(int readLimit)
Marks the current position in this input stream.

The mark(int) method of BaseNCodecInputStream does nothing.

Overrides:
mark in class FilterInputStream
Parameters:
readLimit - the maximum limit of bytes that can be read before the mark position becomes invalid.
Since:
1.7

markSupported

public boolean markSupported()

Overrides:
markSupported in class FilterInputStream
Returns:
always returns false

read

public int read()
         throws IOException
Reads one byte from this input stream.

Overrides:
read in class FilterInputStream
Returns:
the byte as an integer in the range 0 to 255. Returns -1 if EOF has been reached.
Throws:
IOException - if an I/O error occurs.

read

public int read(byte[] b,
                int offset,
                int len)
         throws IOException
Attempts to read len bytes into the specified b array starting at offset from this InputStream.

Overrides:
read in class FilterInputStream
Parameters:
b - destination byte array
offset - where to start writing the bytes
len - maximum number of bytes to read
Returns:
number of bytes read
Throws:
IOException - if an I/O error occurs.
NullPointerException - if the byte array parameter is null
IndexOutOfBoundsException - if offset, len or buffer size are invalid

reset

public void reset()
           throws IOException
Repositions this stream to the position at the time the mark method was last called on this input stream.

The reset() method of BaseNCodecInputStream does nothing except throw an IOException.

Overrides:
reset in class FilterInputStream
Throws:
IOException - if this method is invoked
Since:
1.7

skip

public long skip(long n)
          throws IOException

Overrides:
skip in class FilterInputStream
Throws:
IllegalArgumentException - if the provided skip length is negative
IOException
Since:
1.7


Copyright © 2002-2013 The Apache Software Foundation. All Rights Reserved.