com.serialpundit.serial

Class SerialComOutByteStream

java.lang.Object

java.io.OutputStream

com.serialpundit.serial.SerialComOutByteStream

All Implemented Interfaces:

ISerialIOStream, Closeable, Flushable, AutoCloseable

public final class SerialComOutByteStream
extends OutputStream
implements ISerialIOStream

Represents an output stream of bytes that gets sent over to serial port for transmission.

Author:

Rishi Gupta

Constructor Summary

Constructors

Constructor and Description
SerialComOutByteStream(SerialComManager scm, SerialComPortHandleInfo portHandleInfo, long handle, SerialComManager.SMODE streamMode) Allocates a new SerialComOutByteStream object.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() This method releases the OutputStream object internally associated with the operating handle.
void	flush() SCM always flushes data every time writeBytes() method is called.
void	write(byte[] data) Writes data.length bytes from the specified byte array to this output stream.
void	write(byte[] data, int off, int len) Writes len bytes from the specified byte array starting at offset off to this output stream.
void	write(int data) Writes the specified byte to this output stream (eight low-order bits of the argument data).

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialComOutByteStream

public SerialComOutByteStream(SerialComManager scm,
                      SerialComPortHandleInfo portHandleInfo,
                      long handle,
                      SerialComManager.SMODE streamMode)
                       throws com.serialpundit.core.SerialComException

Allocates a new SerialComOutByteStream object.

Parameters:

scm - instance of SerialComManager class with which this stream will associate itself.

handle - handle of the serial port on which to write data bytes.

streamMode - indicates blocking or non-blocking behavior of stream.

Throws:

com.serialpundit.core.SerialComException - if serial port can not be configured for specified write behavior.

com.serialpundit.core.SerialComException

Method Detail

write

public void write(int data)
           throws IOException

Writes the specified byte to this output stream (eight low-order bits of the argument data). The 24 high-order bits of data are ignored.

Specified by:

write in class OutputStream

Parameters:

data - integer to be written to serial port.

Throws:

IOException - if write fails or output stream has been closed.

write

public void write(byte[] data)
           throws IOException

Writes data.length bytes from the specified byte array to this output stream.

Overrides:

write in class OutputStream

Parameters:

data - byte type array of data to be written to serial port.

Throws:

IOException - if write fails or output stream has been closed.

IllegalArgumentException - if data is null or an empty array.

write

public void write(byte[] data,
         int off,
         int len)
           throws IOException,
                  IndexOutOfBoundsException

Writes len bytes from the specified byte array starting at offset off to this output stream.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array data, then an IndexOutOfBoundsException is thrown.

Overrides:

write in class OutputStream

Parameters:

data - byte type array of data to be written to serial port.

off - offset from where to start sending data.

len - length of data to be written.

Throws:

IOException - if write fails or output stream has been closed.

IllegalArgumentException - if data is not a byte type array.

NullPointerException - if data is null.

IndexOutOfBoundsException - If off is negative, or len is negative, or off+len is greater than the length of the array data.

flush

public void flush()
           throws IOException

SCM always flushes data every time writeBytes() method is called. So do nothing just return.

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException - if write fails or output stream has been closed.

close

public void close()
           throws IOException

This method releases the OutputStream object internally associated with the operating handle.

To actually close the port closeComPort() method should be used.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException - if write fails or output stream has been closed.