com.eurotech.framework.protocol.modbus
Class ModbusProtocolException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.eurotech.framework.protocol.modbus.ModbusProtocolException
All Implemented Interfaces:
Serializable

public class ModbusProtocolException
extends Exception

The ProtocolException class is the superclass of all errors and exceptions in the ESF Protocol project. It extends the JDK Exception class by requesting its invokers to provide an error code when building its instances. The code is one value of ProtocolErrorCode enum; the code is used to document the possible error conditions generated by the platform as well as to identify the localized exception messages to be reported. Exceptions messages are stored in the ProtocolExceptionMessagesBundle Properties Bundle and they are keyed on the exception code.

See Also:
Serialized Form

Field Summary
protected  ModbusProtocolErrorCode m_code
           
 
Constructor Summary
ModbusProtocolException(ModbusProtocolErrorCode code)
          Builds a new EdcException instance based on the supplied EdcErrorCode.
ModbusProtocolException(ModbusProtocolErrorCode code, String complement)
          Builds a new EdcException instance based on the supplied EdcErrorCode and an optional complement string
ModbusProtocolException(ModbusProtocolErrorCode code, Throwable cause, Object... arguments)
          Builds a new EdcException instance based on the supplied EdcErrorCode, an optional Throwable cause, and optional arguments for the associated exception message.
 
Method Summary
 ModbusProtocolErrorCode getCode()
           
 String getLocalizedMessage()
           
 String getMessage()
           
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, 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

m_code

protected ModbusProtocolErrorCode m_code
Constructor Detail

ModbusProtocolException

public ModbusProtocolException(ModbusProtocolErrorCode code)
Builds a new EdcException instance based on the supplied EdcErrorCode.

Parameters:
code -
t -
arguments -

ModbusProtocolException

public ModbusProtocolException(ModbusProtocolErrorCode code,
                               String complement)
Builds a new EdcException instance based on the supplied EdcErrorCode and an optional complement string

Parameters:
code -
t -
arguments -

ModbusProtocolException

public ModbusProtocolException(ModbusProtocolErrorCode code,
                               Throwable cause,
                               Object... arguments)
Builds a new EdcException instance based on the supplied EdcErrorCode, an optional Throwable cause, and optional arguments for the associated exception message.

Parameters:
code -
t -
arguments -
Method Detail

getCode

public ModbusProtocolErrorCode getCode()

getMessage

public String getMessage()
Overrides:
getMessage in class Throwable

getLocalizedMessage

public String getLocalizedMessage()
Overrides:
getLocalizedMessage in class Throwable


Copyright © 2013. All Rights Reserved.