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:
java.io.Closeable
Direct Known Subclasses:
Base32InputStream, Base64InputStream

public class BaseNCodecInputStream
extends java.io.FilterInputStream

Abstract superclass for Base-N input streams.

Since:
1.5

Field Summary
private  BaseNCodec baseNCodec
           
private  boolean doEncode
           
private  byte[] singleByte
           
 
Fields inherited from class java.io.FilterInputStream
in
 
Constructor Summary
protected BaseNCodecInputStream(java.io.InputStream in, BaseNCodec baseNCodec, boolean doEncode)
           
 
Method Summary
 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.
 
Methods inherited from class java.io.FilterInputStream
available, close, mark, read, reset, skip
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

doEncode

private final boolean doEncode

baseNCodec

private final BaseNCodec baseNCodec

singleByte

private final byte[] singleByte
Constructor Detail

BaseNCodecInputStream

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

read

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

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

read

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

Overrides:
read in class java.io.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:
java.io.IOException - if an I/O error occurs.
java.lang.NullPointerException - if the byte array parameter is null
java.lang.IndexOutOfBoundsException - if offset, len or buffer size are invalid

markSupported

public boolean markSupported()

Overrides:
markSupported in class java.io.FilterInputStream
Returns:
false


commons-codec version 1.5-SNAPSHOT - Copyright © 2002-2011 - Apache Software Foundation