com.ibm.portal.state.exceptions
Class InvalidPropertyException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.ibm.portal.state.exceptions.StateException
              extended by com.ibm.portal.state.exceptions.PropertyException
                  extended by com.ibm.portal.state.exceptions.InvalidPropertyException
All Implemented Interfaces:
Localized, java.io.Serializable

public abstract class InvalidPropertyException
extends PropertyException

Exception representing the error case that a property (in particular the property value) specified in a properties file is considered as incorrect.

Since:
5.1
See Also:
Serialized Form

Constructor Summary
InvalidPropertyException(java.lang.String aKey, com.ibm.wps.util.Properties aProps)
          Initializes the exception by specifying the property that is invalid
InvalidPropertyException(java.lang.String aKey, com.ibm.wps.util.Properties aProps, java.lang.Throwable aCause)
          Initializes the exception by specifying the property that is invalid
 
Method Summary
 java.lang.String getMessage()
           
 
Methods inherited from class com.ibm.portal.state.exceptions.PropertyException
getKey, getProps
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.portal.Localized
getDescription, getLocales, getTitle
 

Constructor Detail

InvalidPropertyException

public InvalidPropertyException(java.lang.String aKey,
                                com.ibm.wps.util.Properties aProps)
Initializes the exception by specifying the property that is invalid

Parameters:
aKey - Key of the property in the property collection
aProps - Property collection that contains the invalid property

InvalidPropertyException

public InvalidPropertyException(java.lang.String aKey,
                                com.ibm.wps.util.Properties aProps,
                                java.lang.Throwable aCause)
Initializes the exception by specifying the property that is invalid

Parameters:
aKey - Key of the property in the property collection
aProps - Property collection that contains the invalid property
aCause - Root cause for the exception
Method Detail

getMessage

public java.lang.String getMessage()
Overrides:
getMessage in class java.lang.Throwable
See Also:
Throwable.getMessage()