Top Description Fields Constructors Methods
org.apache.avalon.framework.component

public Class ComponentException

extends CascadingException
Class Inheritance
Imports
org.apache.avalon.framework.CascadingException
The exception thrown to indicate a problem with Components. It is usually thrown by ComponentManager or ComponentSelector.

Deprecated: Use org.apache.avalon.framework.service.ServiceException instead.

Author
Avalon Development Team
Version
$Id: ComponentException.java 506231 2007-02-12 02:36:54Z crossley $

Field Summary

Modifier and TypeField and Description
private final String
m_key

Constructor Summary

AccessConstructor and Description
public
ComponentException(final String
the lookup key
key, final String
the exception message
message, final Throwable
the throwable
throwable)

Construct a new ComponentException instance.

public
ComponentException(final String
the exception message
message, final Throwable
the throwable
throwable)

Deprecated use the String, String, Throwable version to record the role
Construct a new ComponentException instance.
public
ComponentException(final String
the exception message
message)

Deprecated use the String, String version to record the role
Construct a new ComponentException instance.
public
ComponentException(final String
the lookup key
key, final String
the exception message
message)

Construct a new ComponentException instance.

Method Summary

Modifier and TypeMethod and Description
public final String

Returns:

The key which let to the exception.
getKey()

Get the key which let to the exception.

public String

Returns:

exception message.
getMessage()

Overrides java.lang.Throwable.getMessage.

Return a message describing the exception.
public final String

Returns:

The key which let to the exception.
getRole()

Deprecated Use getKey instead
Get the key which let to the exception.
Inherited from org.apache.avalon.framework.CascadingException:
getCause

Field Detail

m_keyback to summary
private final String m_key

Constructor Detail

ComponentExceptionback to summary
public ComponentException(final String key, final String message, final Throwable throwable)

Construct a new ComponentException instance.

Parameters
key:String

the lookup key

message:String

the exception message

throwable:Throwable

the throwable

ComponentExceptionback to summary
public ComponentException(final String message, final Throwable throwable)

Deprecated

use the String, String, Throwable version to record the role

Construct a new ComponentException instance.

Parameters
message:String

the exception message

throwable:Throwable

the throwable

ComponentExceptionback to summary
public ComponentException(final String message)

Deprecated

use the String, String version to record the role

Construct a new ComponentException instance.

Parameters
message:String

the exception message

ComponentExceptionback to summary
public ComponentException(final String key, final String message)

Construct a new ComponentException instance.

Parameters
key:String

the lookup key

message:String

the exception message

Method Detail

getKeyback to summary
public final String getKey()

Get the key which let to the exception. May be null.

Returns:String

The key which let to the exception.

getMessageback to summary
public String getMessage()

Overrides java.lang.Throwable.getMessage.

Return a message describing the exception.

Returns:String

exception message.

getRoleback to summary
public final String getRole()

Deprecated

Use getKey instead

Get the key which let to the exception. May be null.

Returns:String

The key which let to the exception.