Package jssc

Class SerialPortException

java.lang.Object

java.lang.Throwable

java.lang.Exception

jssc.SerialPortException

All Implemented Interfaces:

Serializable

public class SerialPortException
extends Exception

Author:

scream3r

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	TYPE_CANT_REMOVE_LISTENER	Can't remove event listener
static String	TYPE_CANT_SET_MASK	Can't set mask
static String	TYPE_INCORRECT_SERIAL_PORT
static String	TYPE_LISTENER_ALREADY_ADDED	Event listener already added
static String	TYPE_LISTENER_THREAD_INTERRUPTED	Event listener thread interrupted
static String	TYPE_NATIVE_EXCEPTION	Exception occurred in native code
static String	TYPE_NULL_NOT_PERMITTED
static String	TYPE_PARAMETER_IS_NOT_CORRECT
static String	TYPE_PERMISSION_DENIED
static String	TYPE_PORT_ALREADY_OPENED	Port already opened
static String	TYPE_PORT_BUSY
static String	TYPE_PORT_NOT_FOUND
static String	TYPE_PORT_NOT_OPENED	Port not opened

Constructor Summary

Constructors

Constructor	Description
SerialPortException(String portName, String methodName, String exceptionType)	Deprecated.
SerialPortException(SerialPort port, String methodName, String exceptionType)	Constructs a new SerialPortException

Method Summary

Modifier and Type	Method	Description
String	getExceptionType()	Getting exception type
String	getMethodName()	Gets the method name during execution of which the exception was called
SerialPort	getPort()	Gets the SerialPort which threw the exception
String	getPortName()	Deprecated.
static SerialPortException	wrapNativeException(Exception ex, SerialPort port, String methodName)

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_PORT_ALREADY_OPENED

public static final String TYPE_PORT_ALREADY_OPENED

Port already opened

See Also:

Constant Field Values

TYPE_PORT_NOT_OPENED

public static final String TYPE_PORT_NOT_OPENED

Port not opened

See Also:

Constant Field Values

TYPE_CANT_SET_MASK

public static final String TYPE_CANT_SET_MASK

Can't set mask

See Also:

Constant Field Values

TYPE_LISTENER_ALREADY_ADDED

public static final String TYPE_LISTENER_ALREADY_ADDED

Event listener already added

See Also:

Constant Field Values

TYPE_LISTENER_THREAD_INTERRUPTED

public static final String TYPE_LISTENER_THREAD_INTERRUPTED

Event listener thread interrupted

See Also:

Constant Field Values

TYPE_CANT_REMOVE_LISTENER

public static final String TYPE_CANT_REMOVE_LISTENER

Can't remove event listener

See Also:

Constant Field Values

TYPE_PARAMETER_IS_NOT_CORRECT

public static final String TYPE_PARAMETER_IS_NOT_CORRECT

Since:

0.8

See Also:

Constant Field Values

TYPE_NULL_NOT_PERMITTED

public static final String TYPE_NULL_NOT_PERMITTED

Since:

0.8

See Also:

Constant Field Values

TYPE_PORT_BUSY

public static final String TYPE_PORT_BUSY

Since:

0.9.0

See Also:

Constant Field Values

TYPE_PORT_NOT_FOUND

public static final String TYPE_PORT_NOT_FOUND

Since:

0.9.0

See Also:

Constant Field Values

TYPE_PERMISSION_DENIED

public static final String TYPE_PERMISSION_DENIED

Since:

2.2.0

See Also:

Constant Field Values

TYPE_INCORRECT_SERIAL_PORT

public static final String TYPE_INCORRECT_SERIAL_PORT

Since:

2.3.0

See Also:

Constant Field Values

TYPE_NATIVE_EXCEPTION

public static final String TYPE_NATIVE_EXCEPTION

Exception occurred in native code

See Also:

Constant Field Values

Constructor Detail

SerialPortException

public SerialPortException(SerialPort port,
                           String methodName,
                           String exceptionType)

Constructs a new SerialPortException

Parameters:

port - Port which the exception occurred on

methodName - Method name which the exception occurred on

exceptionType - Any SerialPortException.TYPE_*

SerialPortException

@Deprecated
public SerialPortException(String portName,
                           String methodName,
                           String exceptionType)

Deprecated.

Constructs a new SerialPortException Deprecated: Use SerialPortTimeoutException(SerialPort, String, String) instead.

Parameters:

portName - Port which the exception occurred on

methodName - Method name which the exception occurred on

exceptionType - Any SerialPortException.TYPE_*

See Also:

SerialPortException(SerialPort, String, String)

Method Detail

wrapNativeException

public static SerialPortException wrapNativeException(Exception ex,
                                                      SerialPort port,
                                                      String methodName)

getPortName

@Deprecated
public String getPortName()

Deprecated.

Getting port name during operation with which the exception was called Deprecated: Use getPort().getName() instead.

Returns:

Port name

getPort

public SerialPort getPort()

Gets the SerialPort which threw the exception

Returns:

SerialPort object

getMethodName

public String getMethodName()

Gets the method name during execution of which the exception was called

Returns:

Calling method name

getExceptionType

public String getExceptionType()

Getting exception type

Returns:

a value from SerialPortException.TYPE_* or a custom String value if provided