public abstract class AbstractSerialDataReaderWriter extends AbstractSerialDataWriter implements SerialDataReader, SerialDataWriter
Constructor and Description |
---|
AbstractSerialDataReaderWriter() |
Modifier and Type | Method and 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.
|
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.
|
abstract byte[] |
read(int length)
Reads a length of bytes from the port/serial device.
|
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(int length,
OutputStream stream)
Reads a length bytes from the serial port/device into a provided OutputStream.
|
void |
read(OutputStream stream)
Reads all available bytes from the serial device into a provided OutputStream.
|
appendNewLine, write, write, write, write, write, write, write, write, write, write, write, write, write, write, writeln, writeln, writeln, writeln
public AbstractSerialDataReaderWriter()
public abstract int available() throws IllegalStateException, IOException
Get the number of bytes available in the serial data receive buffer.
available
in interface SerialDataReader
IllegalStateException
IOException
public abstract byte[] read() throws IllegalStateException, IOException
Reads all available bytes bytes from the port/serial device.
read
in interface SerialDataReader
IllegalStateException
IOException
public abstract byte[] read(int length) throws IllegalStateException, IOException
Reads a length of bytes from the port/serial device.
read
in interface SerialDataReader
length
- The number of bytes to get from the serial port/device.
This number must not be higher than the number of available bytes.IllegalStateException
IOException
public void discardData() throws IllegalStateException, IOException
discard/drain all available bytes from the serial port/device.
discardData
in interface SerialDataReader
IllegalStateException
IOException
public void read(ByteBuffer buffer) throws IllegalStateException, IOException
Reads all available bytes from the serial device into a provided ByteBuffer.
read
in interface SerialDataReader
buffer
- The ByteBuffer object to write to.IllegalStateException
IOException
public void read(int length, ByteBuffer buffer) throws IllegalStateException, IOException
Reads a length bytes from the serial port/device into a provided ByteBuffer.
read
in interface SerialDataReader
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.IllegalStateException
IOException
public void read(OutputStream stream) throws IllegalStateException, IOException
Reads all available bytes from the serial device into a provided OutputStream.
read
in interface SerialDataReader
stream
- The OutputStream object to write to.IllegalStateException
IOException
public void read(int length, OutputStream stream) throws IllegalStateException, IOException
Reads a length bytes from the serial port/device into a provided OutputStream.
read
in interface SerialDataReader
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.IllegalStateException
IOException
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.
read
in interface SerialDataReader
collection
- The collection of CharSequence objects to append to.IllegalStateException
IOException
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.
read
in interface SerialDataReader
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.IllegalStateException
IOException
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.
read
in interface SerialDataReader
charset
- The character set to use for encoding/decoding bytes to/from text charactersIllegalStateException
IOException
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.
read
in interface SerialDataReader
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 charactersIllegalStateException
IOException
public void read(Charset charset, Writer writer) throws IllegalStateException, IOException
Reads all available bytes from the serial port/device into a provided Writer.
read
in interface SerialDataReader
charset
- The character set to use for encoding/decoding bytes to/from text characterswriter
- The Writer object to write to.IllegalStateException
IOException
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.
read
in interface SerialDataReader
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 characterswriter
- The Writer object to write to.IllegalStateException
IOException
Copyright © 2012–2019 Pi4J. All rights reserved.