com.sparetimelabs.serial

Class CommPortIdentifier

java.lang.Object

com.sparetimelabs.serial.CommPortIdentifier

public class CommPortIdentifier
extends Object

The type Comm port identifier.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PORT_PARALLEL The constant PORT_PARALLEL.
static int	PORT_SERIAL The constant PORT_SERIAL.

Method Summary

Modifier and Type	Method and Description
static void	addPortName(String portName, int portType, CommDriver driver) This has not been tested at all
void	addPortOwnershipListener(CommPortOwnershipListener listener) Add port ownership listener.
boolean	equals(Object x)
String	getCurrentOwner() Gets current owner.
String	getName() Gets name.
static CommPortIdentifier	getPortIdentifier(CommPort port) Gets port identifier.
static CommPortIdentifier	getPortIdentifier(String portName) Gets port identifier.
static Enumeration	getPortIdentifiers() Gets port identifiers.
int	getPortType() Gets port type.
int	hashCode()
boolean	isCurrentlyOwned() Is currently owned boolean.
CommPort	open(FileDescriptor fd) Open comm port.
CommPort	open(String appname, int timeout) Open comm port.
void	removePortOwnershipListener(CommPortOwnershipListener listener) Remove port ownership listener.

Methods inherited from class java.lang.Object

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

Field Detail

PORT_SERIAL

public static final int PORT_SERIAL

The constant PORT_SERIAL.

See Also:

Constant Field Values

PORT_PARALLEL

public static final int PORT_PARALLEL

The constant PORT_PARALLEL.

See Also:

Constant Field Values

Method Detail

equals

public boolean equals(Object x)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

addPortName

public static void addPortName(String portName,
                               int portType,
                               CommDriver driver)

This has not been tested at all

Parameters:

portName - the port name

portType - the port type

driver - the driver

getPortIdentifier

public static CommPortIdentifier getPortIdentifier(String portName)
                                            throws NoSuchPortException

Gets port identifier.

Parameters:

portName - the port name

Returns:

the port identifier

Throws:

NoSuchPortException - the no such port exception

getPortIdentifier

public static CommPortIdentifier getPortIdentifier(CommPort port)
                                            throws NoSuchPortException

Gets port identifier.

Parameters:

port - the port

Returns:

the port identifier

Throws:

NoSuchPortException - the no such port exception

open

public CommPort open(String appname,
                     int timeout)
              throws PortInUseException

Open comm port.

Parameters:

appname - the appname

timeout - the timeout

Returns:

the comm port

Throws:

PortInUseException - the port in use exception

open

public CommPort open(FileDescriptor fd)
              throws UnsupportedCommOperationException

Open comm port.

Parameters:

fd - the fd

Returns:

the comm port

Throws:

UnsupportedCommOperationException - the unsupported comm operation exception

getName

public String getName()

Gets name.

Returns:

the name

getPortType

public int getPortType()

Gets port type.

Returns:

the port type

getPortIdentifiers

public static Enumeration getPortIdentifiers()

Gets port identifiers.

Returns:

the port identifiers

getCurrentOwner

public String getCurrentOwner()

Gets current owner.

Returns:

the current owner

isCurrentlyOwned

public boolean isCurrentlyOwned()

Is currently owned boolean.

Returns:

the boolean

addPortOwnershipListener

public void addPortOwnershipListener(CommPortOwnershipListener listener)

Add port ownership listener.

Parameters:

listener - the listener

removePortOwnershipListener

public void removePortOwnershipListener(CommPortOwnershipListener listener)

Remove port ownership listener.

Parameters:

listener - the listener