edu.wisc.ssec.mcidas.adde
Class AddeException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by edu.wisc.ssec.mcidas.McIDASException
              extended by edu.wisc.ssec.mcidas.adde.AddeException
All Implemented Interfaces:
Serializable

public class AddeException
extends McIDASException

AddeException class is to handle exceptions when dealing with ADDE access to data. More general than AddeURLException.

Author:
Don Murray - Unidata
See Also:
Serialized Form

Constructor Summary
AddeException()
          Constructs an AddeException with no specified detail message.
AddeException(int errorCode)
          Constructs an AddeException with an ADDE error code in place of a detail message.
AddeException(int errorCode, String message)
          Constructs an AddeException with an ADDE error code and a detail message.
AddeException(String message)
          Constructs an AddeException with the specified detail message.
 
Method Summary
 int getAddeErrorCode()
          Returns the ADDE error code associated with this exception.
 boolean hasAddeErrorCode()
          Determine whether or not an error code has been provided for this exception.
 
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
 

Constructor Detail

AddeException

public AddeException()
Constructs an AddeException with no specified detail message.


AddeException

public AddeException(String message)
Constructs an AddeException with the specified detail message.

Parameters:
message - The detail message.

AddeException

public AddeException(int errorCode)
Constructs an AddeException with an ADDE error code in place of a detail message.

Parameters:
errorCode - ADDE error code.

AddeException

public AddeException(int errorCode,
                     String message)
Constructs an AddeException with an ADDE error code and a detail message.

Parameters:
errorCode - ADDE error code;
message - Detail message.
Method Detail

getAddeErrorCode

public int getAddeErrorCode()
Returns the ADDE error code associated with this exception. Note: you should first check for the presence of an error code via hasAddeErrorCode().

Returns:
The ADDE error code associated with this exception.

hasAddeErrorCode

public boolean hasAddeErrorCode()
Determine whether or not an error code has been provided for this exception.

Returns:
Whether or not an ADDE error code has been provided.