org.harctoolbox.harchardware.comm

Class LocalSerialPortBuffered

java.lang.Object

org.harctoolbox.harchardware.comm.LocalSerialPort

org.harctoolbox.harchardware.comm.LocalSerialPortBuffered

All Implemented Interfaces:

Closeable, AutoCloseable, IHarcHardware, IStringCommand

public final class LocalSerialPortBuffered
extends LocalSerialPort
implements IStringCommand

Nested Class Summary

Nested classes/interfaces inherited from class org.harctoolbox.harchardware.comm.LocalSerialPort

LocalSerialPort.FlowControl, LocalSerialPort.Parity

Field Summary

Fields inherited from class org.harctoolbox.harchardware.comm.LocalSerialPort

debug, defaultPort, inStream, outStream, verbose

Constructor Summary

Constructors

Constructor and Description
LocalSerialPortBuffered(int portNumber)
LocalSerialPortBuffered(String portName)
LocalSerialPortBuffered(String portName, int baud, boolean verbose)
LocalSerialPortBuffered(String portName, int baud, int length, int stopBits, LocalSerialPort.Parity parity, LocalSerialPort.FlowControl flowControl, int timeout, boolean verbose)

Method Summary

Modifier and Type	Method and Description
static void	main(String[] args)
void	open() Opens the device with previously set parameters.
void	open(boolean iterate) This version of open tries, if its argument is true, to open the "following" device if opening of the requested device fails.
String	readString() Reads a line of text.
String	readString(boolean wait)
boolean	ready() Tells whether this stream is ready to be read.
void	sendByte(byte b)
void	sendBytes(byte[] data)
void	sendBytes(byte[] data, int offset, int length)
void	sendString(String cmd)
void	waitFor(String goal, String areUThere, int delay, int tries)

Methods inherited from class org.harctoolbox.harchardware.comm.LocalSerialPort

close, dropDTR, flush, flushInput, getActualPortName, getSerialPortName, getSerialPortNames, getVersion, isValid, setDebug, setDTR, setTimeout, setVerbosity

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.harctoolbox.harchardware.IHarcHardware

getVersion, isValid, setDebug, setTimeout, setVerbosity

Methods inherited from interface java.io.Closeable

close

Constructor Detail

LocalSerialPortBuffered

public LocalSerialPortBuffered(String portName,
                               int baud,
                               int length,
                               int stopBits,
                               LocalSerialPort.Parity parity,
                               LocalSerialPort.FlowControl flowControl,
                               int timeout,
                               boolean verbose)
                        throws gnu.io.NoSuchPortException,
                               gnu.io.PortInUseException,
                               gnu.io.UnsupportedCommOperationException,
                               IOException

Throws:

gnu.io.NoSuchPortException

gnu.io.PortInUseException

gnu.io.UnsupportedCommOperationException

IOException

LocalSerialPortBuffered

public LocalSerialPortBuffered(String portName,
                               int baud,
                               boolean verbose)
                        throws gnu.io.NoSuchPortException,
                               gnu.io.PortInUseException,
                               gnu.io.UnsupportedCommOperationException,
                               IOException

Throws:

gnu.io.NoSuchPortException

gnu.io.PortInUseException

gnu.io.UnsupportedCommOperationException

IOException

LocalSerialPortBuffered

public LocalSerialPortBuffered(String portName)
                        throws gnu.io.NoSuchPortException,
                               gnu.io.PortInUseException,
                               gnu.io.UnsupportedCommOperationException,
                               IOException

Throws:

gnu.io.NoSuchPortException

gnu.io.PortInUseException

gnu.io.UnsupportedCommOperationException

IOException

LocalSerialPortBuffered

public LocalSerialPortBuffered(int portNumber)
                        throws IOException,
                               gnu.io.NoSuchPortException,
                               gnu.io.PortInUseException,
                               gnu.io.UnsupportedCommOperationException

Throws:

IOException

gnu.io.NoSuchPortException

gnu.io.PortInUseException

gnu.io.UnsupportedCommOperationException

Method Detail

open

public void open()
          throws HarcHardwareException,
                 IOException

Description copied from interface: IHarcHardware

Opens the device with previously set parameters.

Specified by:

open in interface IHarcHardware

Overrides:

open in class LocalSerialPort

Throws:

HarcHardwareException

IOException

open

public void open(boolean iterate)
          throws HarcHardwareException,
                 IOException

Description copied from class: LocalSerialPort

This version of open tries, if its argument is true, to open the "following" device if opening of the requested device fails. Up to maxtries attempts are made, then a HarcHardwareException is thrown on failure.

Overrides:

open in class LocalSerialPort

Throws:

HarcHardwareException

IOException

sendString

public void sendString(String cmd)
                throws IOException

Specified by:

sendString in interface IStringCommand

Throws:

IOException

sendBytes

public void sendBytes(byte[] data)
               throws IOException

Throws:

IOException

sendBytes

public void sendBytes(byte[] data,
                      int offset,
                      int length)
               throws IOException

Throws:

IOException

sendByte

public void sendByte(byte b)
              throws IOException

Throws:

IOException

readString

public String readString()
                  throws IOException

Description copied from interface: IStringCommand

Reads a line of text. A line is considered to be terminated by any one of a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a linefeed.

Specified by:

readString in interface IStringCommand

Returns:

A String containing the contents of the line, not including any line-termination characters, or null if no input available.

Throws:

IOException

readString

public String readString(boolean wait)
                  throws IOException

Throws:

IOException

waitFor

public void waitFor(String goal,
                    String areUThere,
                    int delay,
                    int tries)
             throws IOException,
                    HarcHardwareException

Throws:

IOException

HarcHardwareException

ready

public boolean ready()
              throws IOException

Description copied from interface: IStringCommand

Tells whether this stream is ready to be read. A buffered character stream is ready if the buffer is not empty, or if the underlying character stream is ready.

Specified by:

ready in interface IStringCommand

Returns:

True if the next read() is guaranteed not to block for input, false otherwise. Note that returning false does not guarantee that the next read will block.

Throws:

IOException - If an I/O error occurs

main

public static void main(String[] args)