Class AbstractSerialDataWriter
- java.lang.Object
-
- com.pi4j.io.serial.impl.AbstractSerialDataWriter
-
- All Implemented Interfaces:
SerialDataWriter
- Direct Known Subclasses:
AbstractSerialDataReaderWriter
public abstract class AbstractSerialDataWriter extends Object implements SerialDataWriter
-
-
Constructor Summary
Constructors Constructor Description AbstractSerialDataWriter()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected CharSequence
appendNewLine(CharSequence data)
void
write(byte... data)
Sends one of more bytes to the serial device identified by the given file descriptor.void
write(byte[]... data)
Sends one of more bytes arrays to the serial device identified by the given file descriptor.abstract void
write(byte[] data, int offset, int length)
Sends an array of bytes to the serial port/device identified by the given file descriptor.void
write(char... data)
Sends an array of ASCII characters to the serial port/device identified by the given file descriptor.void
write(InputStream input)
Read content from an input stream of data and write it to the serial port transmit buffer.void
write(CharSequence... data)
Sends one or more ASCII string objects to the serial port/device identified by the given file descriptor.void
write(ByteBuffer... data)
Read the content of byte buffer and write the data to the serial port transmit buffer.void
write(CharBuffer... data)
Sends one or more ASCII CharBuffers to the serial port/device identified by the given file descriptor.void
write(Charset charset, char... data)
Sends an array of characters to the serial port/device identified by the given file descriptor.void
write(Charset charset, char[] data, int offset, int length)
Sends an array of characters to the serial port/device identified by the given file descriptor.void
write(Charset charset, CharSequence... data)
Sends one or more string objects to the serial port/device identified by the given file descriptor.void
write(Charset charset, CharBuffer... data)
Sends one or more CharBuffers to the serial port/device identified by the given file descriptor.void
write(Charset charset, Collection<? extends CharSequence> data)
Sends a collection of string objects to the serial port/device identified by the given file descriptor.void
write(Collection<? extends CharSequence> data)
Sends a collection of ASCII string objects to the serial port/device identified by the given file descriptor.void
writeln(CharSequence... data)
Sends one or more ASCII string objects each appended with a line terminator (CR+LF) to the serial port/device.void
writeln(Charset charset, CharSequence... data)
Sends one or more string objects each appended with a line terminator (CR+LF) to the serial port/device.void
writeln(Charset charset, Collection<? extends CharSequence> data)
Sends a collection of string objects each appended with a line terminator (CR+LF) to the serial port/device.void
writeln(Collection<? extends CharSequence> data)
Sends a collection of ASCII string objects each appended with a line terminator (CR+LF) to the serial port/device.
-
-
-
Method Detail
-
write
public abstract void write(byte[] data, int offset, int length) throws IllegalStateException, IOException
Sends an array of bytes to the serial port/device identified by the given file descriptor.
- Specified by:
write
in interfaceSerialDataWriter
- Parameters:
data
- A ByteBuffer of data to be transmitted.offset
- The starting index (inclusive) in the array to send from.length
- The number of bytes from the byte array to transmit to the serial port.- Throws:
IllegalStateException
IOException
-
write
public void write(byte... data) throws IllegalStateException, IOException
Sends one of more bytes to the serial device identified by the given file descriptor.
- Specified by:
write
in interfaceSerialDataWriter
- Parameters:
data
- One or more bytes (or an array) of data to be transmitted. (variable-length-argument)- Throws:
IllegalStateException
IOException
-
write
public void write(byte[]... data) throws IllegalStateException, IOException
Sends one of more bytes arrays to the serial device identified by the given file descriptor.
- Specified by:
write
in interfaceSerialDataWriter
- Parameters:
data
- One or more byte arrays of data to be transmitted. (variable-length-argument)- Throws:
IllegalStateException
IOException
-
write
public void write(ByteBuffer... data) throws IllegalStateException, IOException
Read the content of byte buffer and write the data to the serial port transmit buffer. (The buffer is read from the current position up to the 'limit' value, not the 'capacity'. You may need to rewind() or flip() the byte buffer if you have just written to it.)- Specified by:
write
in interfaceSerialDataWriter
- Parameters:
data
- A ByteBuffer of data to be transmitted.- Throws:
IllegalStateException
IOException
-
write
public void write(InputStream input) throws IllegalStateException, IOException
Read content from an input stream of data and write it to the serial port transmit buffer.- Specified by:
write
in interfaceSerialDataWriter
- Parameters:
input
- An InputStream of data to be transmitted- Throws:
IllegalStateException
IOException
-
write
public void write(Charset charset, char[] data, int offset, int length) throws IllegalStateException, IOException
Sends an array of characters to the serial port/device identified by the given file descriptor.
- Specified by:
write
in interfaceSerialDataWriter
- Parameters:
charset
- The character set to use for encoding/decoding bytes to/from text charactersdata
- An array of chars to be decoded into bytes and transmitted.offset
- The starting index (inclusive) in the array to send from.length
- The number of characters from the char array to transmit to the serial port.- Throws:
IllegalStateException
IOException
-
write
public void write(Charset charset, char... data) throws IllegalStateException, IOException
Sends an array of characters to the serial port/device identified by the given file descriptor.
- Specified by:
write
in interfaceSerialDataWriter
- Parameters:
charset
- The character set to use for encoding/decoding bytes to/from text charactersdata
- One or more characters (or an array) of data to be transmitted. (variable-length-argument)- Throws:
IllegalStateException
IOException
-
write
public void write(char... data) throws IllegalStateException, IOException
Sends an array of ASCII characters to the serial port/device identified by the given file descriptor.
- Specified by:
write
in interfaceSerialDataWriter
- Parameters:
data
- One or more ASCII characters (or an array) of data to be transmitted. (variable-length-argument)- Throws:
IllegalStateException
IOException
-
write
public void write(Charset charset, CharBuffer... data) throws IllegalStateException, IOException
Sends one or more CharBuffers to the serial port/device identified by the given file descriptor.
- Specified by:
write
in interfaceSerialDataWriter
- Parameters:
charset
- The character set to use for encoding/decoding bytes to/from text charactersdata
- One or more CharBuffers (or an array) of data to be transmitted. (variable-length-argument)- Throws:
IllegalStateException
IOException
-
write
public void write(CharBuffer... data) throws IllegalStateException, IOException
Sends one or more ASCII CharBuffers to the serial port/device identified by the given file descriptor.
- Specified by:
write
in interfaceSerialDataWriter
- Parameters:
data
- One or more ASCII CharBuffers (or an array) of data to be transmitted. (variable-length-argument)- Throws:
IllegalStateException
IOException
-
write
public void write(Charset charset, CharSequence... data) throws IllegalStateException, IOException
Sends one or more string objects to the serial port/device identified by the given file descriptor.
- Specified by:
write
in interfaceSerialDataWriter
- Parameters:
charset
- The character set to use for encoding/decoding bytes to/from text charactersdata
- One or more string objects (or an array) of data to be transmitted. (variable-length-argument)- Throws:
IllegalStateException
IOException
-
write
public void write(CharSequence... data) throws IllegalStateException, IOException
Sends one or more ASCII string objects to the serial port/device identified by the given file descriptor.
- Specified by:
write
in interfaceSerialDataWriter
- Parameters:
data
- One or more ASCII string objects (or an array) of data to be transmitted. (variable-length-argument)- Throws:
IllegalStateException
IOException
-
write
public void write(Charset charset, Collection<? extends CharSequence> data) throws IllegalStateException, IOException
Sends a collection of string objects to the serial port/device identified by the given file descriptor.
- Specified by:
write
in interfaceSerialDataWriter
- Parameters:
charset
- The character set to use for encoding/decoding bytes to/from text charactersdata
- A collection of string objects (or an array) of data to be transmitted. (variable-length-argument)- Throws:
IllegalStateException
IOException
-
write
public void write(Collection<? extends CharSequence> data) throws IllegalStateException, IOException
Sends a collection of ASCII string objects to the serial port/device identified by the given file descriptor.
- Specified by:
write
in interfaceSerialDataWriter
- Parameters:
data
- A collection of string objects (or an array) of data to be transmitted. (variable-length-argument)- Throws:
IllegalStateException
IOException
-
appendNewLine
protected CharSequence appendNewLine(CharSequence data)
-
writeln
public void writeln(Charset charset, CharSequence... data) throws IllegalStateException, IOException
Sends one or more string objects each appended with a line terminator (CR+LF) to the serial port/device.
- Specified by:
writeln
in interfaceSerialDataWriter
- Parameters:
charset
- The character set to use for encoding/decoding bytes to/from text charactersdata
- One or more string objects (or an array) of data to be transmitted. (variable-length-argument)- Throws:
IllegalStateException
IOException
-
writeln
public void writeln(CharSequence... data) throws IllegalStateException, IOException
Sends one or more ASCII string objects each appended with a line terminator (CR+LF) to the serial port/device.
- Specified by:
writeln
in interfaceSerialDataWriter
- Parameters:
data
- One or more ASCII string objects (or an array) of data to be transmitted. (variable-length-argument)- Throws:
IllegalStateException
IOException
-
writeln
public void writeln(Charset charset, Collection<? extends CharSequence> data) throws IllegalStateException, IOException
Sends a collection of string objects each appended with a line terminator (CR+LF) to the serial port/device.
- Specified by:
writeln
in interfaceSerialDataWriter
- Parameters:
charset
- The character set to use for encoding/decoding bytes to/from text charactersdata
- A collection of string objects (or an array) of data to be transmitted. (variable-length-argument)- Throws:
IllegalStateException
IOException
-
writeln
public void writeln(Collection<? extends CharSequence> data) throws IllegalStateException, IOException
Sends a collection of ASCII string objects each appended with a line terminator (CR+LF) to the serial port/device.
- Specified by:
writeln
in interfaceSerialDataWriter
- Parameters:
data
- A collection of ASCII string objects (or an array) of data to be transmitted. (variable-length-argument)- Throws:
IllegalStateException
IOException
-
-