uPortal 2.4.1
API Documentation

org.jasig.portal.properties
Class MissingPropertyException

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

public class MissingPropertyException
extends java.lang.RuntimeException

An undeclared (Runtime) exception to be thrown by the PropertiesManager when a property is requested but cannot be found.

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

Constructor Summary
MissingPropertyException(java.lang.String propertyName)
          Instantiate a MissingPropertyException for a particular missing property.
MissingPropertyException(java.lang.String propertyName, boolean alreadyReported)
          Instantiate a MissingPropertyException for a particular missing property, indicating whether the throwing object has already thrown a MissingPropertyException for this property.
 
Method Summary
 java.lang.String getMessage()
           
 java.lang.String getPropertyName()
          Get the name of the missing property.
 boolean isAlreadyReported()
          Has the throwing object already reported (thrown a MissingPropertyException for) this particular missing property.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MissingPropertyException

public MissingPropertyException(java.lang.String propertyName)
Instantiate a MissingPropertyException for a particular missing property.

Parameters:
propertyName - - the name of the property the value of which could not be found.

MissingPropertyException

public MissingPropertyException(java.lang.String propertyName,
                                boolean alreadyReported)
Instantiate a MissingPropertyException for a particular missing property, indicating whether the throwing object has already thrown a MissingPropertyException for this property.

Parameters:
propertyName -
alreadyReported -
Method Detail

getMessage

public java.lang.String getMessage()

isAlreadyReported

public boolean isAlreadyReported()
Has the throwing object already reported (thrown a MissingPropertyException for) this particular missing property. Objects handling this exception might choose to predicate their logging detail on this property, for instance.

Returns:
Returns true this property has already been reported as missing by the throwing object.

getPropertyName

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

Returns:
Returns the name of the missing property.

uPortal 2.4.1
API Documentation