com.serialpundit.serial.internal

Class SerialComPortHandleInfo

java.lang.Object

com.serialpundit.serial.internal.SerialComPortHandleInfo

public final class SerialComPortHandleInfo
extends Object

Encapsulates the information like port handle, looper object, event listener, data listener, port name etc associated with a particular port.

Author:

Rishi Gupta

Constructor Summary

Constructors

Constructor and Description
SerialComPortHandleInfo(String portName, long handle, SerialComLooper looper, ISerialComDataListener dataListener, ISerialComEventListener eventListener) Allocates a new SerialComPortHandleInfo object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsDataListener(ISerialComDataListener dataListener) Check if there already exist a data listener for this handle.
boolean	containsEventListener(ISerialComEventListener eventListener) Check if there is already a registered event listener for this handle.
boolean	containsHandle(long handle) Check if the object of this class have this handle.
boolean	containsPort(String portName) Check if the corresponding port name exist.
ISerialComDataListener	getDataListener() Data Listener associated with this port, info and manipulation.
ISerialComEventListener	getEventListener() Event listener associated with this port, info and manipulation.
SerialComLooper	getLooper() Looper associated with this port, info and manipulation.
String	getOpenedPortName() Get the name of port associated with given handle Callers first find reference to this class object using given handle and then invoke this method.
long	getPortHandle() Returns handle to the opened port.
SerialComInByteStream	getSerialComInByteStream() Return SerialComByteStream object associated with this handle.
SerialComOutByteStream	getSerialComOutByteStream() Return SerialComByteStream object associated with this handle.
void	setDataListener(ISerialComDataListener dataListener) Set the data listener for this handle.
void	setEventListener(ISerialComEventListener eventListener) Set the event listener associated with this handle.
void	setLooper(SerialComLooper looper) Set the looper object that is associated with this handle.
void	setOpenedPortName(String portName) Set the name of port.
void	setPortHandle(long handle) Sets the handle of the port opened.
void	setSerialComInByteStream(SerialComInByteStream serialComInByteStream) Set the SerialComByteStream object associated with this handle.
void	setSerialComOutByteStream(SerialComOutByteStream serialComOutByteStream) Set the SerialComByteStream object associated with this handle.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialComPortHandleInfo

public SerialComPortHandleInfo(String portName,
                       long handle,
                       SerialComLooper looper,
                       ISerialComDataListener dataListener,
                       ISerialComEventListener eventListener)

Allocates a new SerialComPortHandleInfo object.

Parameters:

portName - name of port for which info is to stored.

handle - handle of opened port.

looper - looper object serving this handle.

dataListener - listener to whom data bytes/errors will be delivered for this handle.

eventListener - listener to whom events will be delivered for this handle.

Method Detail

getOpenedPortName

public String getOpenedPortName()

Get the name of port associated with given handle Callers first find reference to this class object using given handle and then invoke this method.

Returns:

name of port.

setOpenedPortName

public void setOpenedPortName(String portName)

Set the name of port.

Parameters:

portName - name of port opened for communication.

containsPort

public boolean containsPort(String portName)
                     throws IllegalArgumentException

Check if the corresponding port name exist.

Parameters:

portName - name of port to find.

Throws:

IllegalArgumentException - if portName is null.

getPortHandle

public long getPortHandle()

Returns handle to the opened port.

Returns:

handle of opened port.

setPortHandle

public void setPortHandle(long handle)

Sets the handle of the port opened.

Parameters:

handle - handle of port after opening it successfully.

containsHandle

public boolean containsHandle(long handle)

Check if the object of this class have this handle.

Returns:

true if object of this class contains given handle false otherwise.

getLooper

public SerialComLooper getLooper()

Looper associated with this port, info and manipulation.

Returns:

looper object for this handle/port.

setLooper

public void setLooper(SerialComLooper looper)

Set the looper object that is associated with this handle.

Parameters:

looper - looper object that will server this port/handle.

getEventListener

public ISerialComEventListener getEventListener()

Event listener associated with this port, info and manipulation.

Returns:

event listener who will get events for this port/handle

setEventListener

public void setEventListener(ISerialComEventListener eventListener)

Set the event listener associated with this handle.

Parameters:

eventListener - event listener who will get events for this port/handle

containsEventListener

public boolean containsEventListener(ISerialComEventListener eventListener)

Check if there is already a registered event listener for this handle.

Parameters:

eventListener - event listener who will get events for this port/handle

getDataListener

public ISerialComDataListener getDataListener()

Data Listener associated with this port, info and manipulation.

Returns:

data listener who will get data bytes/errors for this port/handle

setDataListener

public void setDataListener(ISerialComDataListener dataListener)

Set the data listener for this handle.

Parameters:

dataListener - listener who will get data bytes/errors for this port/handle

containsDataListener

public boolean containsDataListener(ISerialComDataListener dataListener)

Check if there already exist a data listener for this handle.

Parameters:

dataListener - who will get data bytes/errors for this port/handle

getSerialComInByteStream

public SerialComInByteStream getSerialComInByteStream()

Return SerialComByteStream object associated with this handle.

Returns:

input byte stream object for this port/handle

setSerialComInByteStream

public void setSerialComInByteStream(SerialComInByteStream serialComInByteStream)

Set the SerialComByteStream object associated with this handle.

Parameters:

serialComInByteStream - input byte stream object for this port/handle

getSerialComOutByteStream

public SerialComOutByteStream getSerialComOutByteStream()

Return SerialComByteStream object associated with this handle.

Returns:

output byte stream for this port/handle

setSerialComOutByteStream

public void setSerialComOutByteStream(SerialComOutByteStream serialComOutByteStream)

Set the SerialComByteStream object associated with this handle.

Parameters:

serialComOutByteStream - output byte stream for this port/handle