- CascadingError - Error in org.apache.avalon.framework
-
Class from which all exceptions should inherit.
- CascadingError(String, Throwable) - Constructor for error org.apache.avalon.framework.CascadingError
-
Construct a new CascadingError
instance.
- CascadingException - Exception in org.apache.avalon.framework
-
Class from which all exceptions should inherit.
- CascadingException(String) - Constructor for exception org.apache.avalon.framework.CascadingException
-
Construct a new CascadingException
instance.
- CascadingException(String, Throwable) - Constructor for exception org.apache.avalon.framework.CascadingException
-
Construct a new CascadingException
instance.
- CascadingRuntimeException - Exception in org.apache.avalon.framework
-
Class from which all exceptions should inherit.
- CascadingRuntimeException(String, Throwable) - Constructor for exception org.apache.avalon.framework.CascadingRuntimeException
-
Construct a new CascadingRuntimeException
instance.
- CascadingThrowable - Interface in org.apache.avalon.framework
-
Interface which all cascadign throwables should implement.
- checkWriteable() - Method in class org.apache.avalon.framework.parameters.Parameters
-
Checks is this Parameters
object is writeable.
- compareTo(Object) - Method in class org.apache.avalon.framework.Version
-
Compare two versions together according to the
Comparable
interface.
- complies(Version) - Method in class org.apache.avalon.framework.Version
-
Check this Version
against another for compliancy
(compatibility).
- Component - Interface in org.apache.avalon.framework.component
-
This interface identifies classes that can be used as Components
by a Composable
.
- componentAvailable(String) - Method in interface org.apache.avalon.framework.availability.AvailabilityAware
-
Notification that component is available.
- ComponentException - Exception in org.apache.avalon.framework.component
-
The exception thrown to indicate a problem with Components.
- ComponentException(String, String, Throwable) - Constructor for exception org.apache.avalon.framework.component.ComponentException
-
Construct a new ComponentException
instance.
- ComponentException(String, Throwable) - Constructor for exception org.apache.avalon.framework.component.ComponentException
-
Deprecated.
use the String, String, Throwable version to record the role
- ComponentException(String) - Constructor for exception org.apache.avalon.framework.component.ComponentException
-
Deprecated.
use the String, String version to record the role
- ComponentException(String, String) - Constructor for exception org.apache.avalon.framework.component.ComponentException
-
Construct a new ComponentException
instance.
- ComponentManager - Interface in org.apache.avalon.framework.component
-
A ComponentManager
selects Component
s based on a
role.
- ComponentSelector - Interface in org.apache.avalon.framework.component
-
A ComponentSelector
selects Component
s based on a
hint.
- componentUnavailable(String) - Method in interface org.apache.avalon.framework.availability.AvailabilityAware
-
Notification that component is no longer available.
- Composable - Interface in org.apache.avalon.framework.component
-
A Composable
class is one that needs to connect to software
components using a "role" abstraction, thus not depending on particular
implementations but on behavioral interfaces.
- compose(ComponentManager) - Method in interface org.apache.avalon.framework.component.Composable
-
Pass the ComponentManager
to the composer
.
- Configurable - Interface in org.apache.avalon.framework.configuration
-
This interface should be implemented by classes that need to be
configured with custom parameters before initialization.
- Configuration - Interface in org.apache.avalon.framework.configuration
-
Configuration
is a interface encapsulating a configuration node
used to retrieve configuration values.
- ConfigurationException - Exception in org.apache.avalon.framework.configuration
-
Thrown when a Configurable
component cannot be configured
properly, or if a value cannot be retrieved properly.
- ConfigurationException(Configuration) - Constructor for exception org.apache.avalon.framework.configuration.ConfigurationException
-
Construct a new ConfigurationException
instance.
- ConfigurationException(String) - Constructor for exception org.apache.avalon.framework.configuration.ConfigurationException
-
Construct a new ConfigurationException
instance.
- ConfigurationException(String, Throwable) - Constructor for exception org.apache.avalon.framework.configuration.ConfigurationException
-
Construct a new ConfigurationException
instance.
- ConfigurationException(String, Configuration) - Constructor for exception org.apache.avalon.framework.configuration.ConfigurationException
-
Construct a new ConfigurationException
instance.
- ConfigurationException(String, Configuration, Throwable) - Constructor for exception org.apache.avalon.framework.configuration.ConfigurationException
-
Construct a new ConfigurationException
instance.
- configure(Configuration) - Method in interface org.apache.avalon.framework.configuration.Configurable
-
Pass the Configuration
to the Configurable
class.
- Context - Interface in org.apache.avalon.framework.context
-
The context is the interface through which the component and its
container communicate.
- ContextException - Exception in org.apache.avalon.framework.context
-
Exception signalling a badly formed Context.
- ContextException(String) - Constructor for exception org.apache.avalon.framework.context.ContextException
-
Construct a new ContextException
instance.
- ContextException(String, Throwable) - Constructor for exception org.apache.avalon.framework.context.ContextException
-
Construct a new ContextException
instance.
- Contextualizable - Interface in org.apache.avalon.framework.context
-
This inteface should be implemented by components that need
a Context to work.
- contextualize(Context) - Method in interface org.apache.avalon.framework.context.Contextualizable
-
Pass the Context to the component.
- get(Object) - Method in interface org.apache.avalon.framework.context.Context
-
Retrieve an object from Context.
- getAttribute(String) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Return the value of specified attribute.
- getAttribute(String, String) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Returns the value of the attribute specified by its name as a
String
, or the default value if no attribute by
that name exists or is empty.
- getAttributeAsBoolean(String) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Return the boolean
value of the specified parameter contained
in this node.
- getAttributeAsBoolean(String, boolean) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Returns the value of the attribute specified by its name as a
boolean
, or the default value if no attribute by
that name exists or is empty.
- getAttributeAsDouble(String) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Return the double
value of the specified parameter contained
in this node.
- getAttributeAsDouble(String, double) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Returns the value of the attribute specified by its name as a
double
, or the default value if no attribute by
that name exists or is empty.
- getAttributeAsFloat(String) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Return the float
value of the specified parameter contained
in this node.
- getAttributeAsFloat(String, float) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Returns the value of the attribute specified by its name as a
float
, or the default value if no attribute by
that name exists or is empty.
- getAttributeAsInteger(String) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Return the int
value of the specified attribute contained
in this node.
- getAttributeAsInteger(String, int) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Returns the value of the attribute specified by its name as a
int
, or the default value if no attribute by
that name exists or is empty.
- getAttributeAsLong(String) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Returns the value of the attribute specified by its name as a
long
.
- getAttributeAsLong(String, long) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Returns the value of the attribute specified by its name as a
long
, or the default value if no attribute by
that name exists or is empty.
- getAttributeNames() - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Return an array of all attribute names.
- getCause() - Method in error org.apache.avalon.framework.CascadingError
-
Retrieve root cause of the exception.
- getCause() - Method in exception org.apache.avalon.framework.CascadingException
-
Retrieve root cause of the exception.
- getCause() - Method in exception org.apache.avalon.framework.CascadingRuntimeException
-
Retrieve root cause of the exception.
- getCause() - Method in interface org.apache.avalon.framework.CascadingThrowable
-
Returns the root cause of this Throwable
.
- getChild(String) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Return a new Configuration
instance encapsulating the
specified child node.
- getChild(String, boolean) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Return a Configuration
instance encapsulating the specified
child node.
- getChildLogger(String) - Method in interface org.apache.avalon.framework.logger.Logger
-
Create a new child logger.
- getChildren() - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Return an Array
of Configuration
elements containing all node children.
- getChildren(String) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Return an Array
of Configuration
elements containing all node children with the specified name.
- getKey() - Method in exception org.apache.avalon.framework.component.ComponentException
-
Get the key which let to the exception.
- getKey() - Method in exception org.apache.avalon.framework.service.ServiceException
-
Return the key that caused the exception.
- getLocation() - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Return a string describing location of Configuration.
- getLogger() - Method in class org.apache.avalon.framework.logger.AbstractLogEnabled
-
Helper method to allow sub-classes to aquire logger.
- getLookupKey() - Method in exception org.apache.avalon.framework.availability.UnavailableException
-
Returns the key to the component that is no longer available.
- getMajor() - Method in class org.apache.avalon.framework.Version
-
Retrieve major component of version.
- getMessage() - Method in exception org.apache.avalon.framework.component.ComponentException
-
Return a message describing the exception.
- getMessage() - Method in exception org.apache.avalon.framework.configuration.ConfigurationException
-
- getMessage() - Method in exception org.apache.avalon.framework.service.ServiceException
-
Override super's message to add role if applicable.
- getMicro() - Method in class org.apache.avalon.framework.Version
-
Retrieve micro component of version.
- getMinor() - Method in class org.apache.avalon.framework.Version
-
Retrieve minor component of version.
- getName() - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Return the name of the node.
- getName() - Method in class org.apache.avalon.framework.Enum
-
Retrieve the name of this Enum item, set in the constructor.
- getNames() - Method in class org.apache.avalon.framework.parameters.Parameters
-
Retrieve an array of all parameter names.
- getNamespace() - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Returns a string indicating which namespace this Configuration node
belongs to.
- getOffendingConfiguration() - Method in exception org.apache.avalon.framework.configuration.ConfigurationException
-
- getParameter(String) - Method in class org.apache.avalon.framework.parameters.Parameters
-
Retrieve the String
value of the specified parameter.
- getParameter(String, String) - Method in class org.apache.avalon.framework.parameters.Parameters
-
Retrieve the String
value of the specified parameter.
- getParameterAsBoolean(String) - Method in class org.apache.avalon.framework.parameters.Parameters
-
Retrieve the boolean
value of the specified parameter.
- getParameterAsBoolean(String, boolean) - Method in class org.apache.avalon.framework.parameters.Parameters
-
Retrieve the boolean
value of the specified parameter.
- getParameterAsFloat(String) - Method in class org.apache.avalon.framework.parameters.Parameters
-
Retrieve the float
value of the specified parameter.
- getParameterAsFloat(String, float) - Method in class org.apache.avalon.framework.parameters.Parameters
-
Retrieve the float
value of the specified parameter.
- getParameterAsInteger(String) - Method in class org.apache.avalon.framework.parameters.Parameters
-
Retrieve the int
value of the specified parameter.
- getParameterAsInteger(String, int) - Method in class org.apache.avalon.framework.parameters.Parameters
-
Retrieve the int
value of the specified parameter.
- getParameterAsLong(String) - Method in class org.apache.avalon.framework.parameters.Parameters
-
Retrieve the long
value of the specified parameter.
- getParameterAsLong(String, long) - Method in class org.apache.avalon.framework.parameters.Parameters
-
Retrieve the long
value of the specified parameter.
- getParameterNames() - Method in class org.apache.avalon.framework.parameters.Parameters
-
Deprecated.
Use getNames() instead
- getRole() - Method in exception org.apache.avalon.framework.component.ComponentException
-
Deprecated.
Use getKey instead
- getRole() - Method in exception org.apache.avalon.framework.service.ServiceException
-
Deprecated.
Use getKey() instead
- getValue() - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Return the String
value of the node.
- getValue(String) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Returns the value of the configuration element as a String
.
- getValue() - Method in class org.apache.avalon.framework.ValuedEnum
-
Get value of enum item.
- getValueAsBoolean() - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Return the boolean
value of the node.
- getValueAsBoolean(boolean) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Returns the value of the configuration element as a boolean
.
- getValueAsDouble() - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Return the double
value of the node.
- getValueAsDouble(double) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Returns the value of the configuration element as a double
.
- getValueAsFloat() - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Return the float
value of the node.
- getValueAsFloat(float) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Returns the value of the configuration element as a float
.
- getValueAsInteger() - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Return the int
value of the node.
- getValueAsInteger(int) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Returns the value of the configuration element as an int
.
- getValueAsLong() - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Return the long
value of the node.
- getValueAsLong(long) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Returns the value of the configuration element as a long
.
- getVersion(String) - Static method in class org.apache.avalon.framework.Version
-
Parse a version out of a string.
- select(Object) - Method in interface org.apache.avalon.framework.component.ComponentSelector
-
Select the Component
associated with the given hint.
- select(Object) - Method in interface org.apache.avalon.framework.service.ServiceSelector
-
Select the Object
associated with the given policy.
- service(ServiceManager) - Method in interface org.apache.avalon.framework.service.Serviceable
-
Pass the ServiceManager
to the Serviceable
.
- Serviceable - Interface in org.apache.avalon.framework.service
-
A Serviceable is a class that need to connect to software components using
a "role" abstraction, thus not depending on particular implementations
but on behavioral interfaces.
- ServiceException - Exception in org.apache.avalon.framework.service
-
The exception thrown to indicate a problem with service.
- ServiceException(String, Throwable) - Constructor for exception org.apache.avalon.framework.service.ServiceException
-
Deprecated.
use the String,String,Throwable version instead
- ServiceException(String, String, Throwable) - Constructor for exception org.apache.avalon.framework.service.ServiceException
-
Construct a new ServiceException
instance.
- ServiceException(String) - Constructor for exception org.apache.avalon.framework.service.ServiceException
-
Deprecated.
use the String,String version instead
- ServiceException(String, String) - Constructor for exception org.apache.avalon.framework.service.ServiceException
-
Construct a new ServiceException
instance.
- ServiceManager - Interface in org.apache.avalon.framework.service
-
A ServiceManager
selects Object
s based on a
role.
- ServiceSelector - Interface in org.apache.avalon.framework.service
-
A ServiceSelector
selects Object
s based on a
supplied policy.
- setLogger(org.apache.log.Logger) - Method in interface org.apache.avalon.framework.logger.Loggable
-
Deprecated.
Provide component with a logger.
- setParameter(String, String) - Method in class org.apache.avalon.framework.parameters.Parameters
-
Set the String
value of a specified parameter.
- setupLogger(Object) - Method in class org.apache.avalon.framework.logger.AbstractLogEnabled
-
Helper method to setup other components with same logger.
- setupLogger(Object, String) - Method in class org.apache.avalon.framework.logger.AbstractLogEnabled
-
Helper method to setup other components with logger.
- setupLogger(Object, Logger) - Method in class org.apache.avalon.framework.logger.AbstractLogEnabled
-
Helper method to setup other components with logger.
- SingleThreaded - Interface in org.apache.avalon.framework.thread
-
A interface to mark a component as SingleThreaded.
- start() - Method in interface org.apache.avalon.framework.activity.Startable
-
Starts the component.
- Startable - Interface in org.apache.avalon.framework.activity
-
The Startable interface is used when components need to
be "running" to be active.
- stop() - Method in interface org.apache.avalon.framework.activity.Startable
-
Stops the component.
- suspend() - Method in interface org.apache.avalon.framework.activity.Suspendable
-
Suspends the component.
- Suspendable - Interface in org.apache.avalon.framework.activity
-
The Suspendable interface is used when a component
will need to temporarily halt execution of a component.