com.ibm.portal.state.exceptions
Class PropertyException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.ibm.portal.state.exceptions.StateException
              com.ibm.portal.state.exceptions.PropertyException

All Implemented Interfaces:

Localized, java.io.Serializable

Direct Known Subclasses:

InvalidPropertyException, MissingPropertyException

public abstract class PropertyException
extends StateException

Base exception for all error cases occuring when trying to initialize a class via a properties file.

Since:

5.1

See Also:

Serialized Form

Field Summary

protected java.lang.String	key Key of the property in the collection above that caused the exception
protected Properties	props Property collection that contains the invalid property

Constructor Summary

PropertyException(java.lang.String aKey, Properties aProps)
Initializes the exception by specifying the property that is invalid

PropertyException(java.lang.String aKey, Properties aProps, java.lang.Throwable aReason)
Initializes the exception by specifying the property that is invalid

Method Summary

java.lang.String	getKey()
Properties	getProps()

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

Methods inherited from interface com.ibm.portal.Localized

getDescription, getLocales, getTitle

Field Detail

props

protected final Properties props

Property collection that contains the invalid property

key

protected final java.lang.String key

Key of the property in the collection above that caused the exception

Constructor Detail

PropertyException

public PropertyException(java.lang.String aKey,
                         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

PropertyException

public PropertyException(java.lang.String aKey,
                         Properties aProps,
                         java.lang.Throwable aReason)

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

aReason - Original exception that rendered the property invalid

Method Detail

getKey

public java.lang.String getKey()

Returns:

Property collection that contains the invalid property

getProps

public Properties getProps()

Returns:

Key of the property in the collection above that caused the exception