org.jperipheral

Class SerialPort

java.lang.Object

org.jperipheral.SerialPort

All Implemented Interfaces:

Peripheral

public final class SerialPort
extends Object
implements Peripheral

A serial port.

Author:

Gili Tzabari

See Also:

"http://www.lammertbies.nl/comm/info/RS-232_specs.html"

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SerialPort.BaudRate
static class	SerialPort.DataBits The number of data bits in a word.
static class	SerialPort.FlowControl The flow control used by the port.
static class	SerialPort.Parity The parity mode used to detect errors.
static class	SerialPort.StopBits The minimum period of time the line must be idle at the end of each word.

Constructor Summary

Constructors

Constructor and Description
SerialPort(String name) Creates a new SerialPort.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getName() Returns the peripheral name.
int	hashCode()
SerialChannel	newAsynchronousChannel(PeripheralChannelGroup group) Returns a new AsynchronousChannel for communicating with the peripheral.
SerialChannel	newAsynchronousChannel(PeripheralChannelGroup group, long timeout, TimeUnit unit) Returns a new AsynchronousChannel for communicating with the peripheral.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SerialPort

public SerialPort(String name)

Creates a new SerialPort.

Parameters:

name - the port name

Throws:

NullPointerException - if name is null

IllegalStateException - if name.trim().isEmpty()

Method Detail

newAsynchronousChannel

public SerialChannel newAsynchronousChannel(PeripheralChannelGroup group)
                                     throws PeripheralNotFoundException,
                                            PeripheralInUseException

Description copied from interface: Peripheral

Returns a new AsynchronousChannel for communicating with the peripheral.

Specified by:

newAsynchronousChannel in interface Peripheral

Parameters:

group - the channel group

Returns:

a AsynchronousChannel for communicating with the peripheral

Throws:

PeripheralNotFoundException - if the comport does not exist

PeripheralInUseException - if the peripheral is locked by another process

newAsynchronousChannel

public SerialChannel newAsynchronousChannel(PeripheralChannelGroup group,
                                   long timeout,
                                   TimeUnit unit)
                                     throws PeripheralNotFoundException,
                                            PeripheralInUseException

Description copied from interface: Peripheral

Returns a new AsynchronousChannel for communicating with the peripheral.

Specified by:

newAsynchronousChannel in interface Peripheral

Parameters:

group - the channel group

timeout - the minimum amount of time to wait if the peripheral is locked by another process before giving up

unit - the unit of timeout

Returns:

a AsynchronousChannel for communicating with the peripheral

Throws:

PeripheralNotFoundException - if the comport does not exist

PeripheralInUseException - if the peripheral is locked by another process

getName

public String getName()

Description copied from interface: Peripheral

Returns the peripheral name.

Specified by:

getName in interface Peripheral

Returns:

the peripheral name

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object