Class SequenceInputStream

java.lang.Object

java.io.InputStream

org.refcodes.serial.SequenceInputStream

All Implemented Interfaces:

Closeable, AutoCloseable, OffsetAccessor, SequenceAccessor

public class SequenceInputStream
extends InputStream
implements OffsetAccessor, SequenceAccessor

The SequenceInputStream constructs an InputStream from a Sequence.

Nested Class Summary

Nested classes/interfaces inherited from interface OffsetAccessor

OffsetAccessor.OffsetBuilder<B>, OffsetAccessor.OffsetMutator, OffsetAccessor.OffsetProperty

Nested classes/interfaces inherited from interface SequenceAccessor

SequenceAccessor.SequenceBuilder<B>, SequenceAccessor.SequenceMutator, SequenceAccessor.SequenceProperty

Constructor Summary

Constructors

Constructor	Description
SequenceInputStream(Sequence aSequence)	Uses the provided Sequence to provide InputStream functionality.
SequenceInputStream(Sequence aSequence, int aOffset)	Uses the provided Sequence to provide InputStream functionality.

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
int	getOffset()
Sequence	getSequence()	Retrieves the value from the Sequence property.
int	read()
int	read(byte[] aChunk, int aOffset, int aLength)

Methods inherited from class InputStream

mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo

Methods inherited from class Object

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

Constructor Details

SequenceInputStream

public SequenceInputStream(Sequence aSequence)

Uses the provided Sequence to provide InputStream functionality.

Parameters:

aSequence - The Sequence to use.

SequenceInputStream

public SequenceInputStream(Sequence aSequence,
 int aOffset)

Uses the provided Sequence to provide InputStream functionality.

Parameters:

aSequence - The Sequence to use.

aOffset - The offset in the Sequence from where to start.

Method Details

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] aChunk,
 int aOffset,
 int aLength)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

getOffset

public int getOffset()

Specified by:

getOffset in interface OffsetAccessor

getSequence

public Sequence getSequence()

Retrieves the value from the Sequence property. ATTENTION: The original Sequence including the read bytes is returned, use the getOffset() method to access those bytes not yet being read!

Specified by:

getSequence in interface SequenceAccessor

Returns:

The Sequence stored by the Sequence property.