Package com.pi4j.io.serial.impl

Class AbstractSerialDataReaderWriter

java.lang.Object

com.pi4j.io.serial.impl.AbstractSerialDataWriter

com.pi4j.io.serial.impl.AbstractSerialDataReaderWriter

All Implemented Interfaces:

SerialDataReader, SerialDataWriter

Direct Known Subclasses:

SerialImpl

public abstract class AbstractSerialDataReaderWriter
extends AbstractSerialDataWriter
implements SerialDataReader, SerialDataWriter

Constructor Summary

Constructors

Constructor	Description
AbstractSerialDataReaderWriter()

Method Summary

Modifier and Type	Method	Description
abstract int	available()	Get the number of bytes available in the serial data receive buffer.
void	discardData()	discard/drain all available bytes from the serial port/device.
abstract byte[]	read()	Reads all available bytes bytes from the port/serial device.
abstract byte[]	read(int length)	Reads a length of bytes from the port/serial device.
void	read(int length, OutputStream stream)	Reads a length bytes from the serial port/device into a provided OutputStream.
void	read(int length, ByteBuffer buffer)	Reads a length bytes from the serial port/device into a provided ByteBuffer.
CharBuffer	read(int length, Charset charset)	Reads a length of bytes from the port/serial device and returns a CharBuffer from the decoded bytes.
void	read(int length, Charset charset, Writer writer)	Reads a length bytes from the serial port/device into a provided Writer.
void	read(int length, Collection<ByteBuffer> collection)	Reads a length of bytes from the serial port/device into a provided collection of ByteBuffer objects.
void	read(OutputStream stream)	Reads all available bytes from the serial device into a provided OutputStream.
void	read(ByteBuffer buffer)	Reads all available bytes from the serial device into a provided ByteBuffer.
CharBuffer	read(Charset charset)	Reads all available bytes from the port/serial device and returns a CharBuffer from the decoded bytes.
void	read(Charset charset, Writer writer)	Reads all available bytes from the serial port/device into a provided Writer.
void	read(Collection<ByteBuffer> collection)	Reads all available bytes from the serial port/device into a provided collection of ByteBuffer objects.

Methods inherited from class com.pi4j.io.serial.impl.AbstractSerialDataWriter

appendNewLine, write, write, write, write, write, write, write, write, write, write, write, write, write, write, writeln, writeln, writeln, writeln

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pi4j.io.serial.SerialDataWriter

write, write, write, write, write, write, write, write, write, write, write, write, write, write, writeln, writeln, writeln, writeln

Constructor Detail

AbstractSerialDataReaderWriter

public AbstractSerialDataReaderWriter()

Method Detail

available

public abstract int available()
                       throws IllegalStateException,
                              IOException

Get the number of bytes available in the serial data receive buffer.

Specified by:

available in interface SerialDataReader

Returns:

Returns number of bytes available.

Throws:

IllegalStateException

IOException

read

public abstract byte[] read()
                     throws IllegalStateException,
                            IOException

Reads all available bytes bytes from the port/serial device.

Specified by:

read in interface SerialDataReader

Returns:

Returns a byte array with the data read from the serial port.

Throws:

IllegalStateException

IOException

read

public abstract byte[] read(int length)
                     throws IllegalStateException,
                            IOException

Reads a length of bytes from the port/serial device.

Specified by:

read in interface SerialDataReader

Parameters:

length - The number of bytes to get from the serial port/device. This number must not be higher than the number of available bytes.

Returns:

Returns a byte array with the data read from the serial port.

Throws:

IllegalStateException

IOException

discardData

public void discardData()
                 throws IllegalStateException,
                        IOException

discard/drain all available bytes from the serial port/device.

Specified by:

discardData in interface SerialDataReader

Throws:

IllegalStateException

IOException

read

public void read(ByteBuffer buffer)
          throws IllegalStateException,
                 IOException

Reads all available bytes from the serial device into a provided ByteBuffer.

Specified by:

read in interface SerialDataReader

Parameters:

buffer - The ByteBuffer object to write to.

Throws:

IllegalStateException

IOException

read

public void read(int length,
                 ByteBuffer buffer)
          throws IllegalStateException,
                 IOException

Reads a length bytes from the serial port/device into a provided ByteBuffer.

Specified by:

read in interface SerialDataReader

Parameters:

length - The number of bytes to get from the serial port/device. This number must not be higher than the number of available bytes.

buffer - The ByteBuffer object to write to.

Throws:

IllegalStateException

IOException

read

public void read(OutputStream stream)
          throws IllegalStateException,
                 IOException

Reads all available bytes from the serial device into a provided OutputStream.

Specified by:

read in interface SerialDataReader

Parameters:

stream - The OutputStream object to write to.

Throws:

IllegalStateException

IOException

read

public void read(int length,
                 OutputStream stream)
          throws IllegalStateException,
                 IOException

Reads a length bytes from the serial port/device into a provided OutputStream.

Specified by:

read in interface SerialDataReader

Parameters:

length - The number of bytes to get from the serial port/device. This number must not be higher than the number of available bytes.

stream - The OutputStream object to write to.

Throws:

IllegalStateException

IOException

read

public void read(Collection<ByteBuffer> collection)
          throws IllegalStateException,
                 IOException

Reads all available bytes from the serial port/device into a provided collection of ByteBuffer objects.

Specified by:

read in interface SerialDataReader

Parameters:

collection - The collection of CharSequence objects to append to.

Throws:

IllegalStateException

IOException

read

public void read(int length,
                 Collection<ByteBuffer> collection)
          throws IllegalStateException,
                 IOException

Reads a length of bytes from the serial port/device into a provided collection of ByteBuffer objects.

Specified by:

read in interface SerialDataReader

Parameters:

length - The number of bytes to get from the serial port/device. This number must not be higher than the number of available bytes.

collection - The collection of CharSequence objects to append to.

Throws:

IllegalStateException

IOException

read

public CharBuffer read(Charset charset)
                throws IllegalStateException,
                       IOException

Reads all available bytes from the port/serial device and returns a CharBuffer from the decoded bytes.

Specified by:

read in interface SerialDataReader

Parameters:

charset - The character set to use for encoding/decoding bytes to/from text characters

Returns:

Returns a character set with the data read from the serial port.

Throws:

IllegalStateException

IOException

read

public CharBuffer read(int length,
                       Charset charset)
                throws IllegalStateException,
                       IOException

Reads a length of bytes from the port/serial device and returns a CharBuffer from the decoded bytes.

Specified by:

read in interface SerialDataReader

Parameters:

length - The number of bytes to get from the serial port/device. This number must not be higher than the number of available bytes.

charset - The character set to use for encoding/decoding bytes to/from text characters

Returns:

Returns a character set with the data read from the serial port.

Throws:

IllegalStateException

IOException

read

public void read(Charset charset,
                 Writer writer)
          throws IllegalStateException,
                 IOException

Reads all available bytes from the serial port/device into a provided Writer.

Specified by:

read in interface SerialDataReader

Parameters:

charset - The character set to use for encoding/decoding bytes to/from text characters

writer - The Writer object to write to.

Throws:

IllegalStateException

IOException

read

public void read(int length,
                 Charset charset,
                 Writer writer)
          throws IllegalStateException,
                 IOException

Reads a length bytes from the serial port/device into a provided Writer.

Specified by:

read in interface SerialDataReader

Parameters:

length - The number of bytes to get from the serial port/device. This number must not be higher than the number of available bytes.

charset - The character set to use for encoding/decoding bytes to/from text characters

writer - The Writer object to write to.

Throws:

IllegalStateException

IOException