public class ChannelAccessException extends JackieRuntimeException
Exception indicating a Channel Access error. This exception is caused by an error message that was received over the network.
This exception always wraps a ChannelAccessStatus
that gives more
information about the cause of the exception and can be retrieved with
getStatus()
method. It might also store an extended message that was
received over the network and can be retrieved with the
getExtendedMessage()
method.
Constructor and Description |
---|
ChannelAccessException(ChannelAccessStatus status)
Constructs a new exception wrapping the provided status code.
|
ChannelAccessException(ChannelAccessStatus status,
String extendedMessage)
Constructs a new exception wrapping the provided status code.
|
Modifier and Type | Method and Description |
---|---|
String |
getExtendedMessage()
Returns the extended message associated with this exception.
|
ChannelAccessStatus |
getStatus()
Returns the Channel Access status that caused this exception.
|
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
public ChannelAccessException(ChannelAccessStatus status)
Constructs a new exception wrapping the provided status code. The
optional extended message is set to null
.
The getStatus()
method can be used to retrieve the status that
was provided when creating the exception.
status
- Channel Access status that caused the exception.public ChannelAccessException(ChannelAccessStatus status, String extendedMessage)
Constructs a new exception wrapping the provided status code. The
optional extended message might be a message that was received in a
ChannelAccessErrorMessage
.
The getStatus()
and getExtendedMessage()
methods can be
used to retrieve the status and the extended message that were provided
when creating the exception.
status
- Channel Access status that caused the exception.extendedMessage
- text message giving more details about the cause of the
problem (may be null
).public ChannelAccessStatus getStatus()
public String getExtendedMessage()
ChannelAccessErrorMessage
). However, some error
messages do not provide an extended message, so that the extended message
may be null
.null
if no such message is available.Copyright © 2014–2017 aquenos GmbH. All rights reserved.