Module org.refcodes.serial

Package org.refcodes.serial

Class SequenceOutputStream

java.lang.Object

java.io.OutputStream

org.refcodes.serial.SequenceOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, SequenceAccessor

public class SequenceOutputStream
extends OutputStream
implements SequenceAccessor

The SequenceOutputStream constructs an OutputStream from a SerialTransmitter.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.serial.SequenceAccessor

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

Constructor Summary

Constructors

Constructor	Description
SequenceOutputStream()	Uses the provided Sequence to provide OutputStream functionality.
SequenceOutputStream(Sequence aSequence)	Uses the provided Sequence to provide OutputStream functionality.

Method Summary

Modifier and Type	Method	Description
void	close()
Sequence	getSequence()	Retrieves the value from the Sequence property.
void	write(byte[] aBytes, int aOffset, int aLength)
void	write(int aByte)

Methods inherited from class java.io.OutputStream

flush, nullOutputStream, write

Methods inherited from class java.lang.Object

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

Constructor Detail

SequenceOutputStream

public SequenceOutputStream()

Uses the provided Sequence to provide OutputStream functionality.

SequenceOutputStream

public SequenceOutputStream(Sequence aSequence)

Uses the provided Sequence to provide OutputStream functionality.

Parameters:

aSequence - The Sequence to use.

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException

write

public void write(byte[] aBytes,
                  int aOffset,
                  int aLength)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(int aByte)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

getSequence

public Sequence getSequence()

Retrieves the value from the Sequence property.

Specified by:

getSequence in interface SequenceAccessor

Returns:

The Sequence stored by the Sequence property.