Package org.apache.commons.codec.binary
Class BaseNCodecInputStream
java.lang.Object
java.io.InputStream
java.io.FilterInputStream
org.apache.commons.codec.binary.BaseNCodecInputStream
- All Implemented Interfaces:
- Closeable,- AutoCloseable
- Direct Known Subclasses:
- Base16InputStream,- Base32InputStream,- Base64InputStream
Abstract superclass for Base-N input streams.
- Since:
- 1.5
- 
Field SummaryFields inherited from class java.io.FilterInputStreamin
- 
Constructor SummaryConstructorsModifierConstructorDescriptionprotectedBaseNCodecInputStream(InputStream inputStream, BaseNCodec baseNCodec, boolean doEncode) Constructs a new instance.
- 
Method SummaryModifier and TypeMethodDescriptionintbooleanReturns true if decoding behavior is strict.voidmark(int readLimit) Marks the current position in this input stream.booleanintread()Reads onebytefrom this input stream.intread(byte[] array, int offset, int len) Attempts to readlenbytes into the specifiedbarray starting atoffsetfrom this InputStream.voidreset()Repositions this stream to the position at the time the mark method was last called on this input stream.longskip(long n) Methods inherited from class java.io.FilterInputStreamclose, read
- 
Constructor Details- 
BaseNCodecInputStreamConstructs a new instance.- Parameters:
- inputStream- the input stream
- baseNCodec- the codec
- doEncode- set to true to perform encoding, else decoding
 
 
- 
- 
Method Details- 
available- Overrides:
- availablein class- FilterInputStream
- Returns:
- 0if the- InputStreamhas reached- EOF,- 1otherwise
- Throws:
- IOException
- Since:
- 1.7
 
- 
isStrictDecodingReturns true if decoding behavior is strict. Decoding will raise anIllegalArgumentExceptionif trailing bits are not part of a valid encoding.The default is false for lenient encoding. Decoding will compose trailing bits into 8-bit bytes and discard the remainder. - Returns:
- true if using strict decoding
- Since:
- 1.15
 
- 
markMarks the current position in this input stream.The mark(int)method ofBaseNCodecInputStreamdoes nothing.- Overrides:
- markin class- FilterInputStream
- Parameters:
- readLimit- the maximum limit of bytes that can be read before the mark position becomes invalid.
- Since:
- 1.7
- See Also:
 
- 
markSupported- Overrides:
- markSupportedin class- FilterInputStream
- Returns:
- Always returns false
 
- 
readReads onebytefrom this input stream.- Overrides:
- readin 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.
 
- 
readAttempts to readlenbytes into the specifiedbarray starting atoffsetfrom this InputStream.- Overrides:
- readin class- FilterInputStream
- Parameters:
- array- 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
 
- 
resetRepositions this stream to the position at the time the mark method was last called on this input stream.The reset()method ofBaseNCodecInputStreamdoes nothing except throw anIOException.- Overrides:
- resetin class- FilterInputStream
- Throws:
- IOException- if this method is invoked
- Since:
- 1.7
 
- 
skip- Overrides:
- skipin class- FilterInputStream
- Throws:
- IllegalArgumentException- if the provided skip length is negative
- IOException
- Since:
- 1.7
 
 
-