public class SerialPortEvent
extends Object

Author:: scream3r

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`BREAK`	Deprecated.
`static int`	`CTS`	Deprecated.
`static int`	`DSR`	Deprecated.
`static int`	`ERR`	Deprecated.
`static int`	`RING`	Deprecated.
`static int`	`RLSD`	Deprecated.
`static int`	`RXCHAR`	Deprecated.
`static int`	`RXFLAG`	Deprecated.
`static int`	`TXEMPTY`	Deprecated.

Constructor Summary

Constructors
Constructor	Description
`SerialPortEvent(String portName, int eventType, int eventValue)`	Deprecated.
`SerialPortEvent(SerialPort port, int eventType, int eventValue)`	Constructs a SerialPortEvent representing a port, event type and event value.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`int`	`getEventType()`	Getting event type
`int`	`getEventValue()`	Getting event value Event values depending on their types: RXCHAR - bytes count in input buffer RXFLAG - bytes count in input buffer (Not supported in Linux) TXEMPTY - bytes count in output buffer CTS - state of CTS line (0 - OFF, 1 - ON) DSR - state of DSR line (0 - OFF, 1 - ON) RLSD - state of RLSD line (0 - OFF, 1 - ON) BREAK - 0 RING - state of RING line (0 - OFF, 1 - ON) ERR - mask of errors
`SerialPort`	`getPort()`	Getting the port that set off this event
`String`	`getPortName()`	Deprecated.
`boolean`	`isBREAK()`	Convenience method to check if `getEventType()` is `SerialPort.MASK_BREAK`
`boolean`	`isCTS()`	Convenience method to check if `getEventType()` is `SerialPort.MASK_CTS`
`boolean`	`isDSR()`	Convenience method to check if `getEventType()` is `SerialPort.MASK_DSR`
`boolean`	`isERR()`	Convenience method to check if `getEventType()` is `SerialPort.MASK_ERR`
`boolean`	`isRING()`	Convenience method to check if `getEventType()` is `SerialPort.MASK_RING`
`boolean`	`isRLSD()`	Convenience method to check if `getEventType()` is `SerialPort.MASK_RLSD`
`boolean`	`isRXCHAR()`	Convenience method to check if `getEventType()` is `SerialPort.MASK_RXCHAR`
`boolean`	`isRXFLAG()`	Convenience method to check if `getEventType()` is `SerialPort.MASK_RXFLAG`
`boolean`	`isTXEMPTY()`	Convenience method to check if `getEventType()` is `SerialPort.MASK_TXEMPTY`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RXCHAR
```
@Deprecated
public static final int RXCHAR
```
    Deprecated.
    
    Deprecated: Use SerialPort.MASK_RXCHAR instead
    
    See Also:
    
    Constant Field Values
  - RXFLAG
```
@Deprecated
public static final int RXFLAG
```
    Deprecated.
    
    Deprecated: Use SerialPort.MASK_RXFLAG instead
    
    See Also:
    
    Constant Field Values
  - TXEMPTY
```
@Deprecated
public static final int TXEMPTY
```
    Deprecated.
    
    Deprecated: Use SerialPort.MASK_TXEMPTY instead
    
    See Also:
    
    Constant Field Values
  - CTS
```
@Deprecated
public static final int CTS
```
    Deprecated.
    
    Deprecated: Use SerialPort.MASK_CTS instead
    
    See Also:
    
    Constant Field Values
  - DSR
```
@Deprecated
public static final int DSR
```
    Deprecated.
    
    Deprecated: Use SerialPort.MASK_DSR instead
    
    See Also:
    
    Constant Field Values
  - RLSD
```
@Deprecated
public static final int RLSD
```
    Deprecated.
    
    Deprecated: Use SerialPort.MASK_RLSD instead
    
    See Also:
    
    Constant Field Values
  - BREAK
```
@Deprecated
public static final int BREAK
```
    Deprecated.
    
    Deprecated: Use SerialPort.MASK_BREAK instead
    
    See Also:
    
    Constant Field Values
  - ERR
```
@Deprecated
public static final int ERR
```
    Deprecated.
    
    Deprecated: Use SerialPort.MASK_ERR instead
    
    See Also:
    
    Constant Field Values
  - RING
```
@Deprecated
public static final int RING
```
    Deprecated.
    
    Deprecated: Use SerialPort.MASK_RING instead
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SerialPortEvent
```
public SerialPortEvent(SerialPort port,
                       int eventType,
                       int eventValue)
```
    Constructs a SerialPortEvent representing a port, event type and event value.
    
    Parameters:
    
    port - SerialPort object which the event occurred
    
    eventType - Can be any value from SerialPort.MASK_* or LinuxEventThread.INTERRUPT_*
    
    eventValue - Event value which changes context depending on getEventType()
    
    See Also:
    
    getEventType()
  - SerialPortEvent
```
@Deprecated
public SerialPortEvent(String portName,
                       int eventType,
                       int eventValue)
```
    Deprecated.
    
    Constructs a SerialPortEvent representing a port, event type and event value. Deprecated: Use SerialPortEvent(SerialPort, int, int) instead.
    
    Parameters:
    
    portName - port which the event occurred
    
    eventType - Can be any value from SerialPort.MASK_* or LinuxEventThread.INTERRUPT_*
    
    eventValue - Event value which changes context depending on getEventType()
    
    See Also:
    
    SerialPortEvent(SerialPort, int, int)
- Method Detail
  - getPort
```
public SerialPort getPort()
```
    Getting the port that set off this event
    
    Returns:
    
    The SerialPort object the event occurred on
  - getPortName
```
@Deprecated
public String getPortName()
```
    Deprecated.
    
    Getting port name which sent the event
    
    Returns:
    
    The port name the event occurred on
  - getEventType
```
public int getEventType()
```
    Getting event type
    
    Returns:
    
    The SerialPort.MASK_* event mask
  - getEventValue
```
public int getEventValue()
```
    Getting event value
    
    Event values depending on their types:
    RXCHAR - bytes count in input buffer
    RXFLAG - bytes count in input buffer (Not supported in Linux)
    TXEMPTY - bytes count in output buffer
    CTS - state of CTS line (0 - OFF, 1 - ON)
    DSR - state of DSR line (0 - OFF, 1 - ON)
    RLSD - state of RLSD line (0 - OFF, 1 - ON)
    BREAK - 0
    RING - state of RING line (0 - OFF, 1 - ON)
    ERR - mask of errors
    
    Returns:
    
    Event value which changes context depending on getEventType() (see listing)
  - isRXCHAR
```
public boolean isRXCHAR()
```
    Convenience method to check if getEventType() is SerialPort.MASK_RXCHAR
    
    Returns:
    
    true or false
  - isRXFLAG
```
public boolean isRXFLAG()
```
    Convenience method to check if getEventType() is SerialPort.MASK_RXFLAG
    
    Returns:
    
    true or false
  - isTXEMPTY
```
public boolean isTXEMPTY()
```
    Convenience method to check if getEventType() is SerialPort.MASK_TXEMPTY
    
    Returns:
    
    true or false
  - isCTS
```
public boolean isCTS()
```
    Convenience method to check if getEventType() is SerialPort.MASK_CTS
    
    Returns:
    
    true or false
  - isDSR
```
public boolean isDSR()
```
    Convenience method to check if getEventType() is SerialPort.MASK_DSR
    
    Returns:
    
    true or false
  - isRLSD
```
public boolean isRLSD()
```
    Convenience method to check if getEventType() is SerialPort.MASK_RLSD
    
    Returns:
    
    true or false
  - isBREAK
```
public boolean isBREAK()
```
    Convenience method to check if getEventType() is SerialPort.MASK_BREAK
    
    Returns:
    
    true or false
  - isERR
```
public boolean isERR()
```
    Convenience method to check if getEventType() is SerialPort.MASK_ERR
    
    Returns:
    
    true or false
  - isRING
```
public boolean isRING()
```
    Convenience method to check if getEventType() is SerialPort.MASK_RING
    
    Returns:
    
    true or false

Class SerialPortEvent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RXCHAR

RXFLAG

TXEMPTY

CTS

DSR

RLSD

BREAK

ERR

RING

Constructor Detail

SerialPortEvent

SerialPortEvent

Method Detail

getPort

getPortName

getEventType

getEventValue

isRXCHAR

isRXFLAG

isTXEMPTY

isCTS

isDSR

isRLSD

isBREAK

isERR

isRING