org.harctoolbox.harchardware.comm

Class LocalSerialPortBuffered

java.lang.Object

org.harctoolbox.harchardware.comm.LocalSerialPort

org.harctoolbox.harchardware.comm.LocalSerialPortBuffered

All Implemented Interfaces:

Closeable, AutoCloseable, ICommandLineDevice, IHarcHardware

public final class LocalSerialPortBuffered
extends LocalSerialPort
implements ICommandLineDevice

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

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 timeout, 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.
String	readString() Reads a line of text.
String	readString(boolean wait) Reads a line of text.
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) Sends a command (a String) to the instance.
void	setDebug(int debug) Sets a debug parameter.

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

close, dropDTR, flush, flushInput, getPortName, getSerialPortName, getSerialPortNames, getVersion, isValid, 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.ICommandLineDevice

flushInput

Methods inherited from interface org.harctoolbox.harchardware.IHarcHardware

getVersion, isValid, 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 NoSuchPortException,
                               PortInUseException,
                               UnsupportedCommOperationException,
                               IOException

Throws:

NoSuchPortException

PortInUseException

UnsupportedCommOperationException

IOException

LocalSerialPortBuffered

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

Throws:

NoSuchPortException

PortInUseException

UnsupportedCommOperationException

IOException

LocalSerialPortBuffered

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

Throws:

NoSuchPortException

PortInUseException

UnsupportedCommOperationException

IOException

LocalSerialPortBuffered

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

Throws:

NoSuchPortException

PortInUseException

UnsupportedCommOperationException

IOException

LocalSerialPortBuffered

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

Throws:

IOException

NoSuchPortException

PortInUseException

UnsupportedCommOperationException

Method Detail

main

public static void main(String[] args)

open

public void open()
          throws HarcHardwareException,
                 IOException

Description copied from class: LocalSerialPort

Opens the device.

Specified by:

open in interface IHarcHardware

Overrides:

open in class LocalSerialPort

Throws:

HarcHardwareException - Bundles RXTX exceptions together.

IOException

sendString

public void sendString(String cmd)
                throws IOException

Description copied from interface: ICommandLineDevice

Sends a command (a String) to the instance.

Specified by:

sendString in interface ICommandLineDevice

Parameters:

cmd - Command string to be sent.

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: ICommandLineDevice

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 ICommandLineDevice

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

Description copied from interface: ICommandLineDevice

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 ICommandLineDevice

Parameters:

wait - if true, wait until something arrives, otherwise return null if nothing there.

Returns:

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

Throws:

IOException

ready

public boolean ready()
              throws IOException

Description copied from interface: ICommandLineDevice

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 ICommandLineDevice

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

setDebug

public void setDebug(int debug)

Description copied from interface: IHarcHardware

Sets a debug parameter. Exact semantic depends on the implementation.

Specified by:

setDebug in interface IHarcHardware