A B C D E F G I L M N O R S T W

A

addDataListener(SerialPortDataListener) - Method in class com.fazecast.jSerialComm.SerialPort

Adds a SerialPortDataListener to the serial port interface.

B

bytesAvailable() - Method in class com.fazecast.jSerialComm.SerialPort

Returns the number of bytes available without blocking if SerialPort.readBytes(byte[], long) were to be called immediately after this method returns.

bytesAwaitingWrite() - Method in class com.fazecast.jSerialComm.SerialPort

Returns the number of bytes still waiting to be written in the device's output queue.

C

catchException(Exception) - Method in interface com.fazecast.jSerialComm.SerialPortDataListenerWithExceptions

Must be overridden to handle any Java exceptions that occur asynchronously in this data listener.

clearBreak() - Method in class com.fazecast.jSerialComm.SerialPort

Clears the BREAK signal from the serial control line.

clearDTR() - Method in class com.fazecast.jSerialComm.SerialPort

Clears the state of the DTR line to 0.

clearRTS() - Method in class com.fazecast.jSerialComm.SerialPort

Clears the state of the RTS line to 0.

closePort() - Method in class com.fazecast.jSerialComm.SerialPort

Closes this serial port.

com.fazecast.jSerialComm - package com.fazecast.jSerialComm

D

delimiterIndicatesEndOfMessage() - Method in interface com.fazecast.jSerialComm.SerialPortMessageListener

Must be overridden to return whether the message delimiter indicates the end or the beginning of a message.

disablePortConfiguration() - Method in class com.fazecast.jSerialComm.SerialPort

Disables the library from calling any of the underlying device driver configuration methods.

E

EVEN_PARITY - Static variable in class com.fazecast.jSerialComm.SerialPort

F

FLOW_CONTROL_CTS_ENABLED - Static variable in class com.fazecast.jSerialComm.SerialPort

FLOW_CONTROL_DISABLED - Static variable in class com.fazecast.jSerialComm.SerialPort

FLOW_CONTROL_DSR_ENABLED - Static variable in class com.fazecast.jSerialComm.SerialPort

FLOW_CONTROL_DTR_ENABLED - Static variable in class com.fazecast.jSerialComm.SerialPort

FLOW_CONTROL_RTS_ENABLED - Static variable in class com.fazecast.jSerialComm.SerialPort

FLOW_CONTROL_XONXOFF_IN_ENABLED - Static variable in class com.fazecast.jSerialComm.SerialPort

FLOW_CONTROL_XONXOFF_OUT_ENABLED - Static variable in class com.fazecast.jSerialComm.SerialPort

G

getBaudRate() - Method in class com.fazecast.jSerialComm.SerialPort

Gets the current baud rate of the serial port.

getCommPort(String) - Static method in class com.fazecast.jSerialComm.SerialPort

Allocates a SerialPort object corresponding to the user-specified port descriptor.

getCommPorts() - Static method in class com.fazecast.jSerialComm.SerialPort

Returns a list of all available serial ports on this machine.

getCTS() - Method in class com.fazecast.jSerialComm.SerialPort

Returns whether the CTS line is currently asserted.

getDCD() - Method in class com.fazecast.jSerialComm.SerialPort

Returns whether the DCD line is currently asserted.

getDescriptivePortName() - Method in class com.fazecast.jSerialComm.SerialPort

Gets a descriptive string representing this serial port or the device connected to it.

getDeviceReadBufferSize() - Method in class com.fazecast.jSerialComm.SerialPort

Returns the underlying receive buffer size used by the serial port device driver.

getDeviceWriteBufferSize() - Method in class com.fazecast.jSerialComm.SerialPort

Returns the underlying transmit buffer size used by the serial port device driver.

getDSR() - Method in class com.fazecast.jSerialComm.SerialPort

Returns whether the DSR line is currently asserted.

getDTR() - Method in class com.fazecast.jSerialComm.SerialPort

Returns whether the DTR line is currently asserted.

getEventType() - Method in class com.fazecast.jSerialComm.SerialPortEvent

Returns the type of serial port event that caused this object to be created.

getFlowControlSettings() - Method in class com.fazecast.jSerialComm.SerialPort

Returns the flow control settings enabled on this serial port.

getInputStream() - Method in class com.fazecast.jSerialComm.SerialPort

Returns an InputStream object associated with this serial port.

getListeningEvents() - Method in interface com.fazecast.jSerialComm.SerialPortDataListener

Must be overridden to return one or more desired event constants for which the SerialPortDataListener.serialEvent(SerialPortEvent) callback should be triggered.

getMessageDelimiter() - Method in interface com.fazecast.jSerialComm.SerialPortMessageListener

Must be overridden to return the expected message delimiter bytes that must be encountered before the SerialPortDataListener.serialEvent(SerialPortEvent) callback is triggered.

getNumDataBits() - Method in class com.fazecast.jSerialComm.SerialPort

Gets the current number of data bits per word.

getNumStopBits() - Method in class com.fazecast.jSerialComm.SerialPort

Gets the current number of stop bits per word.

getOutputStream() - Method in class com.fazecast.jSerialComm.SerialPort

Returns an OutputStream object associated with this serial port.

getPacketSize() - Method in interface com.fazecast.jSerialComm.SerialPortPacketListener

Must be overridden to return the desired number of bytes that must be read before the SerialPortDataListener.serialEvent(SerialPortEvent) callback is triggered.

getParity() - Method in class com.fazecast.jSerialComm.SerialPort

Gets the current parity error-checking scheme.

getPortDescription() - Method in class com.fazecast.jSerialComm.SerialPort

Gets a description of the port as reported by the device itself.

getReadTimeout() - Method in class com.fazecast.jSerialComm.SerialPort

Gets the number of milliseconds of inactivity to tolerate before returning from a SerialPort.readBytes(byte[],long) call.

getReceivedData() - Method in class com.fazecast.jSerialComm.SerialPortEvent

Returns any raw data bytes associated with this serial port event.

getRI() - Method in class com.fazecast.jSerialComm.SerialPort

Returns whether the RI line is currently asserted.

getRTS() - Method in class com.fazecast.jSerialComm.SerialPort

Returns whether the RTS line is currently asserted.

getSerialPort() - Method in class com.fazecast.jSerialComm.SerialPortEvent

Returns the SerialPort that triggered this event.

getSystemPortName() - Method in class com.fazecast.jSerialComm.SerialPort

Gets the operating system-defined device name corresponding to this serial port.

getVersion() - Static method in class com.fazecast.jSerialComm.SerialPort

Returns the current version of the jSerialComm library.

getWriteTimeout() - Method in class com.fazecast.jSerialComm.SerialPort

Gets the number of milliseconds of inactivity to tolerate before returning from a SerialPort.writeBytes(byte[],long) call.

I

isOpen() - Method in class com.fazecast.jSerialComm.SerialPort

Returns whether the port is currently open and available for communication.

L

LISTENING_EVENT_DATA_AVAILABLE - Static variable in class com.fazecast.jSerialComm.SerialPort

LISTENING_EVENT_DATA_RECEIVED - Static variable in class com.fazecast.jSerialComm.SerialPort

LISTENING_EVENT_DATA_WRITTEN - Static variable in class com.fazecast.jSerialComm.SerialPort

M

MARK_PARITY - Static variable in class com.fazecast.jSerialComm.SerialPort

N

NO_PARITY - Static variable in class com.fazecast.jSerialComm.SerialPort

O

ODD_PARITY - Static variable in class com.fazecast.jSerialComm.SerialPort

ONE_POINT_FIVE_STOP_BITS - Static variable in class com.fazecast.jSerialComm.SerialPort

ONE_STOP_BIT - Static variable in class com.fazecast.jSerialComm.SerialPort

openPort() - Method in class com.fazecast.jSerialComm.SerialPort

Opens this serial port for reading and writing.

openPort(int) - Method in class com.fazecast.jSerialComm.SerialPort

Opens this serial port for reading and writing with an optional delay time.

openPort(int, int, int) - Method in class com.fazecast.jSerialComm.SerialPort

Opens this serial port for reading and writing with an optional delay time and user-specified device buffer size.

R

readBytes(byte[], long) - Method in class com.fazecast.jSerialComm.SerialPort

Reads up to bytesToRead raw data bytes from the serial port and stores them in the buffer.

readBytes(byte[], long, long) - Method in class com.fazecast.jSerialComm.SerialPort

Reads up to bytesToRead raw data bytes from the serial port and stores them in the buffer starting at the indicated offset.

removeDataListener() - Method in class com.fazecast.jSerialComm.SerialPort

Removes the associated SerialPortDataListener from the serial port interface.

S

serialEvent(SerialPortEvent) - Method in interface com.fazecast.jSerialComm.SerialPortDataListener

Called whenever one of the serial port events specified by the SerialPortDataListener.getListeningEvents() method occurs.

SerialPort - Class in com.fazecast.jSerialComm

This class provides native access to serial ports and devices without requiring external libraries or tools.

SerialPortDataListener - Interface in com.fazecast.jSerialComm

This interface must be implemented to enable simple event-based serial port I/O.

SerialPortDataListenerWithExceptions - Interface in com.fazecast.jSerialComm

This interface must be implemented to enable simple event-based serial port I/O with a custom Exception callback.

SerialPortEvent - Class in com.fazecast.jSerialComm

This class describes an asynchronous serial port event.

SerialPortEvent(SerialPort, int) - Constructor for class com.fazecast.jSerialComm.SerialPortEvent

Constructs a SerialPortEvent object corresponding to the specified serial event type.

SerialPortEvent(SerialPort, int, byte[]) - Constructor for class com.fazecast.jSerialComm.SerialPortEvent

Constructs a SerialPortEvent object corresponding to the specified serial event type and containing the passed-in data bytes.

SerialPortInvalidPortException - Exception in com.fazecast.jSerialComm

This class describes a serial port invalid port exception.

SerialPortInvalidPortException() - Constructor for exception com.fazecast.jSerialComm.SerialPortInvalidPortException

Constructs a SerialPortInvalidPortException with null as its error detail message.

SerialPortInvalidPortException(String) - Constructor for exception com.fazecast.jSerialComm.SerialPortInvalidPortException

Constructs a SerialPortInvalidPortException with the specified detail message.

SerialPortInvalidPortException(String, Throwable) - Constructor for exception com.fazecast.jSerialComm.SerialPortInvalidPortException

Constructs a SerialPortInvalidPortException with the specified detail message and cause.

SerialPortInvalidPortException(Throwable) - Constructor for exception com.fazecast.jSerialComm.SerialPortInvalidPortException

Constructs a SerialPortInvalidPortException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

SerialPortIOException - Exception in com.fazecast.jSerialComm

This class describes a serial port IO exception.

SerialPortIOException() - Constructor for exception com.fazecast.jSerialComm.SerialPortIOException

Constructs a SerialPortIOException with null as its error detail message.

SerialPortIOException(String) - Constructor for exception com.fazecast.jSerialComm.SerialPortIOException

Constructs a SerialPortIOException with the specified detail message.

SerialPortIOException(String, Throwable) - Constructor for exception com.fazecast.jSerialComm.SerialPortIOException

Constructs a SerialPortIOException with the specified detail message and cause.

SerialPortIOException(Throwable) - Constructor for exception com.fazecast.jSerialComm.SerialPortIOException

Constructs a SerialPortIOException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

SerialPortMessageListener - Interface in com.fazecast.jSerialComm

This interface must be implemented to enable delimited message reads using event-based serial port I/O.

SerialPortPacketListener - Interface in com.fazecast.jSerialComm

This interface must be implemented to enable full packet reads using event-based serial port I/O.

SerialPortTimeoutException - Exception in com.fazecast.jSerialComm

This class describes a serial port timeout exception.

SerialPortTimeoutException() - Constructor for exception com.fazecast.jSerialComm.SerialPortTimeoutException

Constructs a SerialPortTimeoutException with null as its error detail message.

SerialPortTimeoutException(String) - Constructor for exception com.fazecast.jSerialComm.SerialPortTimeoutException

Constructs a SerialPortTimeoutException with the specified detail message.

setBaudRate(int) - Method in class com.fazecast.jSerialComm.SerialPort

Sets the desired baud rate for this serial port.

setBreak() - Method in class com.fazecast.jSerialComm.SerialPort

Sets the BREAK signal on the serial control line.

setComPortParameters(int, int, int, int) - Method in class com.fazecast.jSerialComm.SerialPort

Sets all serial port parameters at one time.

setComPortParameters(int, int, int, int, boolean) - Method in class com.fazecast.jSerialComm.SerialPort

Sets all serial port parameters at one time.

setComPortTimeouts(int, int, int) - Method in class com.fazecast.jSerialComm.SerialPort

Sets the serial port read and write timeout parameters.

setDTR() - Method in class com.fazecast.jSerialComm.SerialPort

Sets the state of the DTR line to 1.

setFlowControl(int) - Method in class com.fazecast.jSerialComm.SerialPort

Specifies what kind of flow control to enable for this serial port.

setNumDataBits(int) - Method in class com.fazecast.jSerialComm.SerialPort

Sets the desired number of data bits per word.

setNumStopBits(int) - Method in class com.fazecast.jSerialComm.SerialPort

Sets the desired number of stop bits per word.

setParity(int) - Method in class com.fazecast.jSerialComm.SerialPort

Sets the desired parity error-detection scheme to be used.

setRs485ModeParameters(boolean, int, int) - Method in class com.fazecast.jSerialComm.SerialPort

Sets whether to enable RS-485 mode for this device.

setRTS() - Method in class com.fazecast.jSerialComm.SerialPort

Sets the state of the RTS line to 1.

SPACE_PARITY - Static variable in class com.fazecast.jSerialComm.SerialPort

T

TIMEOUT_NONBLOCKING - Static variable in class com.fazecast.jSerialComm.SerialPort

TIMEOUT_READ_BLOCKING - Static variable in class com.fazecast.jSerialComm.SerialPort

TIMEOUT_READ_SEMI_BLOCKING - Static variable in class com.fazecast.jSerialComm.SerialPort

TIMEOUT_SCANNER - Static variable in class com.fazecast.jSerialComm.SerialPort

TIMEOUT_WRITE_BLOCKING - Static variable in class com.fazecast.jSerialComm.SerialPort

toString() - Method in class com.fazecast.jSerialComm.SerialPort

Returns the same output as calling SerialPort.getPortDescription().

TWO_STOP_BITS - Static variable in class com.fazecast.jSerialComm.SerialPort

W

writeBytes(byte[], long) - Method in class com.fazecast.jSerialComm.SerialPort

Writes up to bytesToWrite raw data bytes from the buffer parameter to the serial port.

writeBytes(byte[], long, long) - Method in class com.fazecast.jSerialComm.SerialPort

Writes up to bytesToWrite raw data bytes from the buffer parameter to the serial port starting at the indicated offset.

A B C D E F G I L M N O R S T W