Class OpenStegoException

  • All Implemented Interfaces:
    java.io.Serializable

    public class OpenStegoException
    extends java.lang.Exception
    Custom exception class for OpenStego
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      OpenStegoException​(java.lang.Throwable cause)
      Constructor using default namespace for unhandled exceptions
      OpenStegoException​(java.lang.Throwable cause, java.lang.String namespace, int errorCode)
      Default constructor
      OpenStegoException​(java.lang.Throwable cause, java.lang.String namespace, int errorCode, java.lang.Object... params)
      Constructor which takes object array for parameters for the message
      OpenStegoException​(java.lang.Throwable cause, java.lang.String namespace, int errorCode, java.lang.String param)
      Constructor with a single parameter for the message
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static void addErrorCode​(java.lang.String namespace, int errorCode, java.lang.String labelKey)
      Method to add new error codes to the namespace
      int getErrorCode()
      Get method for errorCode
      java.lang.String getNamespace()
      Get method for namespace
      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, 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

      • INVALID_PASSWORD

        public static final int INVALID_PASSWORD
        Error Code - Invalid password
        See Also:
        Constant Field Values
      • INVALID_USE_COMPR_VALUE

        public static final int INVALID_USE_COMPR_VALUE
        Error Code - Invalid value for useCompression
        See Also:
        Constant Field Values
      • INVALID_USE_ENCRYPT_VALUE

        public static final int INVALID_USE_ENCRYPT_VALUE
        Error Code - Invalid value for useEncryption
        See Also:
        Constant Field Values
      • INVALID_KEY_NAME

        public static final int INVALID_KEY_NAME
        Error Code - Invalid key name
        See Also:
        Constant Field Values
      • CORRUPT_DATA

        public static final int CORRUPT_DATA
        Error Code - Corrupt Data
        See Also:
        Constant Field Values
      • NO_VALID_PLUGIN

        public static final int NO_VALID_PLUGIN
        Error Code - No valid plugin
        See Also:
        Constant Field Values
      • IMAGE_TYPE_INVALID

        public static final int IMAGE_TYPE_INVALID
        Error Code - Image type invalid
        See Also:
        Constant Field Values
      • IMAGE_FILE_INVALID

        public static final int IMAGE_FILE_INVALID
        Error Code - Image file invalid
        See Also:
        Constant Field Values
      • NO_PLUGIN_SPECIFIED

        public static final int NO_PLUGIN_SPECIFIED
        Error Code - No plugin specified
        See Also:
        Constant Field Values
      • PLUGIN_DOES_NOT_SUPPORT_WM

        public static final int PLUGIN_DOES_NOT_SUPPORT_WM
        Error Code - Plugin does not support watermarking
        See Also:
        Constant Field Values
      • PLUGIN_NOT_FOUND

        public static final int PLUGIN_NOT_FOUND
        Error Code - Plugin not found
        See Also:
        Constant Field Values
      • IMAGE_SIZE_MISMATCH

        public static final int IMAGE_SIZE_MISMATCH
        Error Code - Image sizes mismatch
        See Also:
        Constant Field Values
      • OUT_OF_MEMORY

        public static final int OUT_OF_MEMORY
        Error Code - Out of memory
        See Also:
        Constant Field Values
      • PLUGIN_DOES_NOT_SUPPORT_DH

        public static final int PLUGIN_DOES_NOT_SUPPORT_DH
        Error Code - Plugin does not support data hiding
        See Also:
        Constant Field Values
      • PWD_MANDATORY_FOR_GENSIG

        public static final int PWD_MANDATORY_FOR_GENSIG
        Error Code - Password is mandatory for 'gensig' operation
        See Also:
        Constant Field Values
      • INVALID_CRYPT_ALGO

        public static final int INVALID_CRYPT_ALGO
        Error Code - Invalid key name
        See Also:
        Constant Field Values
      • USERPREF_INVALID_INT

        public static final int USERPREF_INVALID_INT
        Error Code - Invalid integer in user preference file
        See Also:
        Constant Field Values
      • USERPREF_INVALID_FLOAT

        public static final int USERPREF_INVALID_FLOAT
        Error Code - Invalid float in user preference file
        See Also:
        Constant Field Values
      • USERPREF_INVALID_BOOL

        public static final int USERPREF_INVALID_BOOL
        Error Code - Invalid boolean in user preference file
        See Also:
        Constant Field Values
    • Constructor Detail

      • OpenStegoException

        public OpenStegoException​(java.lang.Throwable cause)
        Constructor using default namespace for unhandled exceptions
        Parameters:
        cause - Original exception which caused this exception to be raised
      • OpenStegoException

        public OpenStegoException​(java.lang.Throwable cause,
                                  java.lang.String namespace,
                                  int errorCode)
        Default constructor
        Parameters:
        cause - Original exception which caused this exception to be raised
        namespace - Namespace of the error
        errorCode - Error code for the exception
      • OpenStegoException

        public OpenStegoException​(java.lang.Throwable cause,
                                  java.lang.String namespace,
                                  int errorCode,
                                  java.lang.String param)
        Constructor with a single parameter for the message
        Parameters:
        cause - Original exception which caused this exception to be raised
        namespace - Namespace of the error
        errorCode - Error code for the exception
        param - Parameter for exception message
      • OpenStegoException

        public OpenStegoException​(java.lang.Throwable cause,
                                  java.lang.String namespace,
                                  int errorCode,
                                  java.lang.Object... params)
        Constructor which takes object array for parameters for the message
        Parameters:
        cause - Original exception which caused this exception to be raised
        namespace - Namespace of the error
        errorCode - Error code for the exception
        params - Parameters for exception message
    • Method Detail

      • getErrorCode

        public int getErrorCode()
        Get method for errorCode
        Returns:
        errorCode
      • getNamespace

        public java.lang.String getNamespace()
        Get method for namespace
        Returns:
        namespace
      • addErrorCode

        public static void addErrorCode​(java.lang.String namespace,
                                        int errorCode,
                                        java.lang.String labelKey)
        Method to add new error codes to the namespace
        Parameters:
        namespace - Namespace for the error
        errorCode - Error code of the error
        labelKey - Key of the label for the error