uPortal 2.4.1
API Documentation

org.jasig.portal.properties
Class BadPropertyException

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended byjava.lang.RuntimeException
              extended byorg.jasig.portal.properties.BadPropertyException
All Implemented Interfaces:
java.io.Serializable

public class BadPropertyException
extends java.lang.RuntimeException

This is an undeclared (Runtime) exception to be thrown by the PropertiesManager when a property is requested but cannot be parsed and returned as the desired type.

Author:
andrew.petro@yale.edu
See Also:
Serialized Form

Constructor Summary
BadPropertyException(java.lang.String propertyName, java.lang.String propertyValue, java.lang.String desiredType)
          Instantiate a new BadPropertyException.
 
Method Summary
 java.lang.String getDesiredType()
          Get the desired type as which the property could not be parsed.
 java.lang.String getLocalizedMessage()
           
 java.lang.String getMessage()
           
 java.lang.String getPropertyName()
          Get the name of the bad property.
 java.lang.String getPropertyValue()
          Get the actual value of the property.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BadPropertyException

public BadPropertyException(java.lang.String propertyName,
                            java.lang.String propertyValue,
                            java.lang.String desiredType)
Instantiate a new BadPropertyException.

Parameters:
propertyName - - the name of the property
propertyValue - - the bad value of the property.
desiredType - - the name of the desired type which the value wasn't, making it bad.
Method Detail

getMessage

public java.lang.String getMessage()

getLocalizedMessage

public java.lang.String getLocalizedMessage()

getDesiredType

public java.lang.String getDesiredType()
Get the desired type as which the property could not be parsed.

Returns:
Returns the desiredType.

getPropertyName

public java.lang.String getPropertyName()
Get the name of the bad property.

Returns:
Returns the propertyName.

getPropertyValue

public java.lang.String getPropertyValue()
Get the actual value of the property.

Returns:
Returns the propertyValue.

uPortal 2.4.1
API Documentation