org.apache.avalon.framework.availability

Class UnavailableException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.avalon.framework.availability.UnavailableException

All Implemented Interfaces:

java.io.Serializable

public class UnavailableException
extends java.lang.RuntimeException

Exception to signal component is not available. UnavailableException is thrown in any method to another component, but only if the caller implements AvailabilityAware.

Since:

4.5

Version:

$Id$

Author:

Avalon Development Team

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	m_Key

Constructor Summary

Constructors

Constructor and Description
UnavailableException(java.lang.String message, java.lang.String key) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getLookupKey() Returns the key to the component that is no longer available.

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

m_Key

private java.lang.String m_Key

Constructor Detail

UnavailableException

public UnavailableException(java.lang.String message,
                    java.lang.String key)

Constructor.

Parameters:

message - The non-localized message to be embedded into the exception.

key - The key that the caller used to lookup the component with.

Method Detail

getLookupKey

public java.lang.String getLookupKey()

Returns the key to the component that is no longer available.