com.pi4j.io.serial.impl.AbstractSerialDataReaderWriter Maven / Gradle / Ivy
package com.pi4j.io.serial.impl;
/*
* #%L
* **********************************************************************
ORGANIZATION : Pi4J
PROJECT : Pi4J :: Java Library (Core)
FILENAME : AbstractSerialDataReaderWriter.java
This file is part of the Pi4J project. More information about
this project can be found here: http://www.pi4j.com/
**********************************************************************
* %%
* Copyright (C) 2012 - 2018 Pi4J
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Lesser Public License for more details.
*
* You should have received a copy of the GNU General Lesser Public
* License along with this program. If not, see
* .
* #L%
*/
import com.pi4j.io.serial.SerialDataReader;
import com.pi4j.io.serial.SerialDataWriter;
import java.io.IOException;
import java.io.OutputStream;
import java.io.Writer;
import java.nio.ByteBuffer;
import java.nio.CharBuffer;
import java.nio.charset.Charset;
import java.util.Collection;
public abstract class AbstractSerialDataReaderWriter extends AbstractSerialDataWriter implements SerialDataReader, SerialDataWriter {
// ----------------------------------------
// READ OPERATIONS
// ----------------------------------------
/**
* Get the number of bytes available in the serial data receive buffer.
*
* @return Returns number of bytes available.
*/
@Override
public abstract int available() throws IllegalStateException, IOException;
/**
* Reads all available bytes bytes from the port/serial device.
*
* @return Returns a byte array with the data read from the serial port.
*/
public abstract byte[] read() throws IllegalStateException, IOException;
/**
* Reads a length of bytes from the port/serial device.
*
* @param length
* The number of bytes to get from the serial port/device.
* This number must not be higher than the number of available bytes.
*
* @return Returns a byte array with the data read from the serial port.
*/
public abstract byte[] read(int length) throws IllegalStateException, IOException;
/**
* discard/drain all available bytes from the serial port/device.
*/
public void discardData() throws IllegalStateException, IOException{
read(); // simply read all bytes and do nothing with them to drain the buffer
}
/**
* Reads all available bytes from the serial device into a provided ByteBuffer.
*
* @param buffer
* The ByteBuffer object to write to.
*/
public void read(ByteBuffer buffer) throws IllegalStateException, IOException {
buffer.put(read());
}
/**
* Reads a length bytes from the serial port/device into a provided ByteBuffer.
*
* @param length
* The number of bytes to get from the serial port/device.
* This number must not be higher than the number of available bytes.
* @param buffer
* The ByteBuffer object to write to.
*
*/
public void read(int length, ByteBuffer buffer) throws IllegalStateException, IOException {
buffer.put(read(length));
}
/**
* Reads all available bytes from the serial device into a provided OutputStream.
*
* @param stream
* The OutputStream object to write to.
*/
public void read(OutputStream stream) throws IllegalStateException, IOException {
stream.write(read());
}
/**
* Reads a length bytes from the serial port/device into a provided OutputStream.
*
* @param length
* The number of bytes to get from the serial port/device.
* This number must not be higher than the number of available bytes.
* @param stream
* The OutputStream object to write to.
*
*/
public void read(int length, OutputStream stream) throws IllegalStateException, IOException {
stream.write(read(length));
}
/**
* Reads all available bytes from the serial port/device into a provided collection of ByteBuffer objects.
*
* @param collection
* The collection of CharSequence objects to append to.
*
*/
public void read(Collection collection) throws IllegalStateException, IOException {
collection.add(ByteBuffer.wrap(read()));
}
/**
* Reads a length of bytes from the serial port/device into a provided collection of ByteBuffer objects.
*
* @param length
* The number of bytes to get from the serial port/device.
* This number must not be higher than the number of available bytes.
* @param collection
* The collection of CharSequence objects to append to.
*
*/
public void read(int length, Collection collection) throws IllegalStateException, IOException {
collection.add(ByteBuffer.wrap(read()));
}
/**
* Reads all available bytes from the port/serial device and returns a CharBuffer from the decoded bytes.
*
* @param charset
* The character set to use for encoding/decoding bytes to/from text characters
*
* @return Returns a character set with the data read from the serial port.
*/
public CharBuffer read(Charset charset) throws IllegalStateException, IOException {
return charset.decode(ByteBuffer.wrap(read()));
}
/**
* Reads a length of bytes from the port/serial device and returns a CharBuffer from the decoded bytes.
*
* @param length
* The number of bytes to get from the serial port/device.
* This number must not be higher than the number of available bytes.
* @param charset
* The character set to use for encoding/decoding bytes to/from text characters
*
* @return Returns a character set with the data read from the serial port.
*/
public CharBuffer read(int length, Charset charset) throws IllegalStateException, IOException{
return charset.decode(ByteBuffer.wrap(read(length)));
}
/**
* Reads all available bytes from the serial port/device into a provided Writer.
*
* @param charset
* The character set to use for encoding/decoding bytes to/from text characters
* @param writer
* The Writer object to write to.
*
*/
public void read(Charset charset, Writer writer) throws IllegalStateException, IOException {
writer.write(read(charset).toString());
}
/**
* Reads a length bytes from the serial port/device into a provided Writer.
*
* @param length
* The number of bytes to get from the serial port/device.
* This number must not be higher than the number of available bytes.
* @param charset
* The character set to use for encoding/decoding bytes to/from text characters
* @param writer
* The Writer object to write to.
*
*/
public void read(int length, Charset charset, Writer writer) throws IllegalStateException, IOException {
writer.write(read(length, charset).toString());
}
}