Index
All Classes and Interfaces|All Packages|Serialized Form
A
- AbstractLogEnabled - Class in org.apache.avalon.framework.logger
-
Utility class to allow easy construction of components that will perform logging.
- AbstractLogEnabled() - Constructor for class org.apache.avalon.framework.logger.AbstractLogEnabled
- AvailabilityAware - Interface in org.apache.avalon.framework.availability
-
An Availability contract between the container and the component.
C
- CascadingError - Exception Class in org.apache.avalon.framework
-
Class from which all exceptions should inherit.
- CascadingError(String, Throwable) - Constructor for exception class org.apache.avalon.framework.CascadingError
-
Construct a new
CascadingError
instance. - CascadingException - Exception Class in org.apache.avalon.framework
-
Class from which all exceptions should inherit.
- CascadingException(String) - Constructor for exception class org.apache.avalon.framework.CascadingException
-
Construct a new
CascadingException
instance. - CascadingException(String, Throwable) - Constructor for exception class org.apache.avalon.framework.CascadingException
-
Construct a new
CascadingException
instance. - CascadingRuntimeException - Exception Class in org.apache.avalon.framework
-
Class from which all exceptions should inherit.
- CascadingRuntimeException(String, Throwable) - Constructor for exception class 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 aComposable
. - componentAvailable(String) - Method in interface org.apache.avalon.framework.availability.AvailabilityAware
-
Notification that component is available.
- ComponentException - Exception Class in org.apache.avalon.framework.component
-
The exception thrown to indicate a problem with Components.
- ComponentException(String) - Constructor for exception class org.apache.avalon.framework.component.ComponentException
-
Deprecated.use the String, String version to record the role
- ComponentException(String, String) - Constructor for exception class org.apache.avalon.framework.component.ComponentException
-
Construct a new
ComponentException
instance. - ComponentException(String, String, Throwable) - Constructor for exception class org.apache.avalon.framework.component.ComponentException
-
Construct a new
ComponentException
instance. - ComponentException(String, Throwable) - Constructor for exception class org.apache.avalon.framework.component.ComponentException
-
Deprecated.use the String, String, Throwable version to record the role
- ComponentManager - Interface in org.apache.avalon.framework.component
-
A
ComponentManager
selectsComponent
s based on a role. - ComponentSelector - Interface in org.apache.avalon.framework.component
-
A
ComponentSelector
selectsComponent
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 thecomposer
. - 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 Class in org.apache.avalon.framework.configuration
-
Thrown when a
Configurable
component cannot be configured properly, or if a value cannot be retrieved properly. - ConfigurationException(String) - Constructor for exception class org.apache.avalon.framework.configuration.ConfigurationException
-
Construct a new
ConfigurationException
instance. - ConfigurationException(String, Throwable) - Constructor for exception class org.apache.avalon.framework.configuration.ConfigurationException
-
Construct a new
ConfigurationException
instance. - ConfigurationException(String, Configuration) - Constructor for exception class org.apache.avalon.framework.configuration.ConfigurationException
-
Construct a new
ConfigurationException
instance. - ConfigurationException(String, Configuration, Throwable) - Constructor for exception class org.apache.avalon.framework.configuration.ConfigurationException
-
Construct a new
ConfigurationException
instance. - ConfigurationException(Configuration) - Constructor for exception class 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 theConfigurable
class. - Context - Interface in org.apache.avalon.framework.context
-
The context is the interface through which the component and its container communicate.
- ContextException - Exception Class in org.apache.avalon.framework.context
-
Exception signalling a badly formed Context.
- ContextException(String) - Constructor for exception class org.apache.avalon.framework.context.ContextException
-
Construct a new
ContextException
instance. - ContextException(String, Throwable) - Constructor for exception class 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.
D
- Data Model - Search tag in interface org.apache.avalon.framework.configuration.Configuration
- Section
- debug(String) - Method in interface org.apache.avalon.framework.logger.Logger
-
Log a debug message.
- debug(String, Throwable) - Method in interface org.apache.avalon.framework.logger.Logger
-
Log a debug message.
- Disposable - Interface in org.apache.avalon.framework.activity
-
The Disposable interface is used when components need to deallocate and dispose resources prior to their destruction.
- dispose() - Method in interface org.apache.avalon.framework.activity.Disposable
-
The dispose operation is called at the end of a components lifecycle.
E
- EMPTY_PARAMETERS - Static variable in class org.apache.avalon.framework.parameters.Parameters
-
Empty Parameters object
- enableLogging(Logger) - Method in class org.apache.avalon.framework.logger.AbstractLogEnabled
-
Set the components logger.
- enableLogging(Logger) - Method in interface org.apache.avalon.framework.logger.LogEnabled
-
Provide component with a logger.
- Enum - Class in org.apache.avalon.framework
-
Basic enum class for type-safe enums.
- Enum(String) - Constructor for class org.apache.avalon.framework.Enum
-
Constructor to add a new named item.
- Enum(String, Map) - Constructor for class org.apache.avalon.framework.Enum
-
Constructor to add a new named item.
- equals(Object) - Method in class org.apache.avalon.framework.Enum
-
Tests for equality.
- equals(Object) - Method in class org.apache.avalon.framework.parameters.Parameters
-
Compare this parameters instance with the supplied object for equality.
- equals(Object) - Method in class org.apache.avalon.framework.ValuedEnum
-
Tests for equality.
- equals(Object) - Method in class org.apache.avalon.framework.Version
-
Indicates whether some other object is "equal to" this
Version
. - equals(Version) - Method in class org.apache.avalon.framework.Version
-
Check this
Version
against another for equality. - error(String) - Method in interface org.apache.avalon.framework.logger.Logger
-
Log a error message.
- error(String, Throwable) - Method in interface org.apache.avalon.framework.logger.Logger
-
Log a error message.
- Example - Search tag in interface org.apache.avalon.framework.configuration.Configuration
- Section
- Example 1: Specification of Canonical Key - Search tag in interface org.apache.avalon.framework.context.Context
- Section
- Example 2: Specification of Canonical Key With Aliasing - Search tag in interface org.apache.avalon.framework.context.Context
- Section
- Examples, where the data is specified in a sample XML format: - Search tag in interface org.apache.avalon.framework.context.Context
- Section
- Executable - Interface in org.apache.avalon.framework.activity
-
The Executable can be implemented by components that need to perform some work.
- execute() - Method in interface org.apache.avalon.framework.activity.Executable
-
Execute the action associated with this component.
F
- fatalError(String) - Method in interface org.apache.avalon.framework.logger.Logger
-
Log a fatalError message.
- fatalError(String, Throwable) - Method in interface org.apache.avalon.framework.logger.Logger
-
Log a fatalError message.
- fromConfiguration(Configuration) - Static method in class org.apache.avalon.framework.parameters.Parameters
-
Create a
Parameters
object from aConfiguration
object. - fromConfiguration(Configuration, String) - Static method in class org.apache.avalon.framework.parameters.Parameters
-
Create a
Parameters
object from aConfiguration
object using the supplied element name. - fromProperties(Properties) - Static method in class org.apache.avalon.framework.parameters.Parameters
-
Create a
Parameters
object from aProperties
object.
G
- 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 exception class org.apache.avalon.framework.CascadingError
-
Retrieve root cause of the exception.
- getCause() - Method in exception class org.apache.avalon.framework.CascadingException
-
Retrieve root cause of the exception.
- getCause() - Method in exception class 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
ofConfiguration
elements containing all node children. - getChildren(String) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Return an
Array
ofConfiguration
elements containing all node children with the specified name. - getKey() - Method in exception class org.apache.avalon.framework.component.ComponentException
-
Get the key which let to the exception.
- getKey() - Method in exception class 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 class 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 class org.apache.avalon.framework.component.ComponentException
-
Return a message describing the exception.
- getMessage() - Method in exception class org.apache.avalon.framework.configuration.ConfigurationException
- getMessage() - Method in exception class 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 class 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 class org.apache.avalon.framework.component.ComponentException
-
Deprecated.Use getKey instead
- getRole() - Method in exception class 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() - Method in class org.apache.avalon.framework.ValuedEnum
-
Get value of enum item.
- getValue(String) - Method in interface org.apache.avalon.framework.configuration.Configuration
-
Returns the value of the configuration element as a
String
. - 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.
H
- hasComponent(Object) - Method in interface org.apache.avalon.framework.component.ComponentSelector
-
Check to see if a
Component
exists for a hint. - hasComponent(String) - Method in interface org.apache.avalon.framework.component.ComponentManager
-
Check to see if a
Component
exists for a key. - hashCode() - Method in class org.apache.avalon.framework.Enum
- hashCode() - Method in class org.apache.avalon.framework.parameters.Parameters
-
Returns a hashed value of the Parameters instance.
- hashCode() - Method in class org.apache.avalon.framework.ValuedEnum
- hashCode() - Method in class org.apache.avalon.framework.Version
-
Add a hashing function to ensure the Version object is treated as expected in hashmaps and sets.
- hasService(String) - Method in interface org.apache.avalon.framework.service.ServiceManager
-
Check to see if a
Object
exists for a key.
I
- info(String) - Method in interface org.apache.avalon.framework.logger.Logger
-
Log a info message.
- info(String, Throwable) - Method in interface org.apache.avalon.framework.logger.Logger
-
Log a info message.
- Initializable - Interface in org.apache.avalon.framework.activity
-
The Initializable interface is used by components that need to allocate resources prior to them becoming active.
- initialize() - Method in interface org.apache.avalon.framework.activity.Initializable
-
Initialize the component.
- isDebugEnabled() - Method in interface org.apache.avalon.framework.logger.Logger
-
Determine if messages of priority "debug" will be logged.
- isEqualTo(ValuedEnum) - Method in class org.apache.avalon.framework.ValuedEnum
-
Test if enum item is equal in value to other enum.
- isErrorEnabled() - Method in interface org.apache.avalon.framework.logger.Logger
-
Determine if messages of priority "error" will be logged.
- isFatalErrorEnabled() - Method in interface org.apache.avalon.framework.logger.Logger
-
Determine if messages of priority "fatalError" will be logged.
- isGreaterThan(ValuedEnum) - Method in class org.apache.avalon.framework.ValuedEnum
-
Test if enum item is greater than in value to other enum.
- isGreaterThanOrEqual(ValuedEnum) - Method in class org.apache.avalon.framework.ValuedEnum
-
Test if enum item is greater than or equal in value to other enum.
- isInfoEnabled() - Method in interface org.apache.avalon.framework.logger.Logger
-
Determine if messages of priority "info" will be logged.
- isLessThan(ValuedEnum) - Method in class org.apache.avalon.framework.ValuedEnum
-
Test if enum item is less than in value to other enum.
- isLessThanOrEqual(ValuedEnum) - Method in class org.apache.avalon.framework.ValuedEnum
-
Test if enum item is less than or equal in value to other enum.
- isParameter(String) - Method in class org.apache.avalon.framework.parameters.Parameters
-
Test if the specified parameter can be retrieved.
- isSelectable(Object) - Method in interface org.apache.avalon.framework.service.ServiceSelector
-
Check to see if a
Object
exists relative to the supplied policy. - isWarnEnabled() - Method in interface org.apache.avalon.framework.logger.Logger
-
Determine if messages of priority "warn" will be logged.
L
- LogEnabled - Interface in org.apache.avalon.framework.logger
-
Components that need to log can implement this interface to be provided Loggers.
- Loggable - Interface in org.apache.avalon.framework.logger
-
Deprecated.Use
LogEnabled
instead. - Logger - Interface in org.apache.avalon.framework.logger
-
This is a facade for the different logging subsystems.
- lookup(String) - Method in interface org.apache.avalon.framework.component.ComponentManager
-
Get the
Component
associated with the given key. - lookup(String) - Method in interface org.apache.avalon.framework.service.ServiceManager
-
Get the
Object
associated with the given key.
M
- m_config - Variable in exception class org.apache.avalon.framework.configuration.ConfigurationException
- m_key - Variable in exception class org.apache.avalon.framework.component.ComponentException
- m_key - Variable in exception class org.apache.avalon.framework.service.ServiceException
- m_Key - Variable in exception class org.apache.avalon.framework.availability.UnavailableException
- m_logger - Variable in class org.apache.avalon.framework.logger.AbstractLogEnabled
- m_major - Variable in class org.apache.avalon.framework.Version
- m_micro - Variable in class org.apache.avalon.framework.Version
- m_minor - Variable in class org.apache.avalon.framework.Version
- m_name - Variable in class org.apache.avalon.framework.Enum
-
The string representation of the Enum.
- m_parameters - Variable in class org.apache.avalon.framework.parameters.Parameters
- m_readOnly - Variable in class org.apache.avalon.framework.parameters.Parameters
- m_throwable - Variable in exception class org.apache.avalon.framework.CascadingError
- m_throwable - Variable in exception class org.apache.avalon.framework.CascadingException
-
The Throwable that caused this exception to be thrown.
- m_throwable - Variable in exception class org.apache.avalon.framework.CascadingRuntimeException
- m_value - Variable in class org.apache.avalon.framework.ValuedEnum
-
The value contained in enum.
- makeReadOnly() - Method in class org.apache.avalon.framework.parameters.Parameters
-
Make this Parameters read-only so that it will throw a
IllegalStateException
if someone tries to modify it. - merge(Parameters) - Method in class org.apache.avalon.framework.parameters.Parameters
-
Merge parameters from another
Parameters
instance into this. - Meta Specification - Search tag in package org.apache.avalon.framework.context
- Section
- Migration from This Package - Search tag in package org.apache.avalon.framework.component
- Section
- Miscellanea - Search tag in interface org.apache.avalon.framework.configuration.Configuration
- Section
N
- Namespace support - Search tag in interface org.apache.avalon.framework.configuration.Configuration
- Section
O
- org.apache.avalon.framework - package org.apache.avalon.framework
-
The Framework part of Avalon contains interfaces and contracts surrounding those interfaces, along with default implementations of some of those interfaces.
- org.apache.avalon.framework.activity - package org.apache.avalon.framework.activity
-
Activity related interfaces covering component initialization, execution, startable and stoppable components, suspension, and disposal.
- org.apache.avalon.framework.availability - package org.apache.avalon.framework.availability
- org.apache.avalon.framework.component - package org.apache.avalon.framework.component
-
Deprecated: use the interfaces in the
org.apache.avalon.framework.service
package instead. - org.apache.avalon.framework.configuration - package org.apache.avalon.framework.configuration
-
Component configuration interfaces and XML-based implementations.
- org.apache.avalon.framework.context - package org.apache.avalon.framework.context
-
Interfaces and implementation of the Context model through which runtime context can be applied by a manager to a component.
- org.apache.avalon.framework.logger - package org.apache.avalon.framework.logger
-
Abstract logging framework supporting pluggable logging mechanisms including LogKit, Log4J and the JDK 1.4 logging infrastructure.
- org.apache.avalon.framework.parameters - package org.apache.avalon.framework.parameters
-
Interfaces supporting the supply of flat configuration information.
- org.apache.avalon.framework.service - package org.apache.avalon.framework.service
-
Interfaces and default implementation of a service management framework supporting container based service lookup and decommissioning.
- org.apache.avalon.framework.thread - package org.apache.avalon.framework.thread
-
Interfaces enabling declaration of single threaded and thread-safe components.
P
- ParameterException - Exception Class in org.apache.avalon.framework.parameters
-
Thrown when a
Parameterizable
component cannot be parameterized properly, or if a value cannot be retrieved properly. - ParameterException(String) - Constructor for exception class org.apache.avalon.framework.parameters.ParameterException
-
Construct a new
ParameterException
instance. - ParameterException(String, Throwable) - Constructor for exception class org.apache.avalon.framework.parameters.ParameterException
-
Construct a new
ParameterException
instance. - Parameterizable - Interface in org.apache.avalon.framework.parameters
-
Components should implement this interface if they wish to be provided with parameters during startup.
- parameterize(Parameters) - Method in interface org.apache.avalon.framework.parameters.Parameterizable
-
Provide component with parameters.
- Parameters - Class in org.apache.avalon.framework.parameters
-
The
Parameters
class represents a set of key-value pairs. - Parameters() - Constructor for class org.apache.avalon.framework.parameters.Parameters
- parseInt(String) - Method in class org.apache.avalon.framework.parameters.Parameters
-
Parses string represenation of the
int
value. - parseLong(String) - Method in class org.apache.avalon.framework.parameters.Parameters
-
Parses string represenation of the
long
value.
R
- Recomposable - Interface in org.apache.avalon.framework.component
-
Deprecated.Deprecated with no replacement. The Recomposable interface is a legacy interface with no concrete contracts. Rather than copy the design mistake to the "service" package, we no longer support this class.
- recompose(ComponentManager) - Method in interface org.apache.avalon.framework.component.Recomposable
-
Deprecated.Repass the
ComponentManager
to thecomposer
. - Reconfigurable - Interface in org.apache.avalon.framework.configuration
-
Extends
Configurable
to allow reconfiguration at runtime. - reconfigure(Configuration) - Method in interface org.apache.avalon.framework.configuration.Reconfigurable
-
Describe
reconfigure
method here. - Recontextualizable - Interface in org.apache.avalon.framework.context
-
Extends Contextualizable to allow recontextualizing.
- recontextualize(Context) - Method in interface org.apache.avalon.framework.context.Recontextualizable
-
Pass the new Context to the component.
- release(Object) - Method in interface org.apache.avalon.framework.service.ServiceManager
-
Return the
Object
when you are finished with it. - release(Object) - Method in interface org.apache.avalon.framework.service.ServiceSelector
-
Return the
Object
when you are finished with it. - release(Component) - Method in interface org.apache.avalon.framework.component.ComponentManager
-
Return the
Component
when you are finished with it. - release(Component) - Method in interface org.apache.avalon.framework.component.ComponentSelector
-
Return the
Component
when you are finished with it. - removeParameter(String) - Method in class org.apache.avalon.framework.parameters.Parameters
-
Remove a parameter from the parameters object
- Reparameterizable - Interface in org.apache.avalon.framework.parameters
-
Components should implement this interface if they wish to be provided with parameters during its lifetime.
- reparameterize(Parameters) - Method in interface org.apache.avalon.framework.parameters.Reparameterizable
-
Provide component with parameters.
- Resolvable - Interface in org.apache.avalon.framework.context
-
This interface is used to indicate objects that need to be resolved in some particular context.
- resolve(Context) - Method in interface org.apache.avalon.framework.context.Resolvable
-
Resolve a object to a value.
- resume() - Method in interface org.apache.avalon.framework.activity.Suspendable
-
Resumes the component.
S
- 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 theServiceable
. - 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 Class in org.apache.avalon.framework.service
-
The exception thrown to indicate a problem with service.
- ServiceException(String) - Constructor for exception class org.apache.avalon.framework.service.ServiceException
-
Deprecated.use the String,String version instead
- ServiceException(String, String) - Constructor for exception class org.apache.avalon.framework.service.ServiceException
-
Construct a new
ServiceException
instance. - ServiceException(String, String, Throwable) - Constructor for exception class org.apache.avalon.framework.service.ServiceException
-
Construct a new
ServiceException
instance. - ServiceException(String, Throwable) - Constructor for exception class org.apache.avalon.framework.service.ServiceException
-
Deprecated.use the String,String,Throwable version instead
- ServiceManager - Interface in org.apache.avalon.framework.service
-
A
ServiceManager
selectsObject
s based on a role. - ServiceSelector - Interface in org.apache.avalon.framework.service
-
A
ServiceSelector
selectsObject
s based on a supplied policy. - setLogger(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.
- Standard Context Entries Specification - Search tag in package org.apache.avalon.framework.context
- Section
- 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.
T
- ThreadSafe - Interface in org.apache.avalon.framework.thread
-
A interface to mark a component as ThreadSafe or reentrant.
- toProperties(Parameters) - Static method in class org.apache.avalon.framework.parameters.Parameters
-
Creates a
java.util.Properties
object from an Avalon Parameters object. - toString() - Method in class org.apache.avalon.framework.Enum
-
Human readable description of this Enum item.
- toString() - Method in class org.apache.avalon.framework.parameters.Parameters
- toString() - Method in class org.apache.avalon.framework.ValuedEnum
-
Override toString method to produce human readable description.
- toString() - Method in class org.apache.avalon.framework.Version
-
Overload toString to report version correctly.
U
- UnavailableException - Exception Class in org.apache.avalon.framework.availability
-
Exception to signal component is not available.
- UnavailableException(String, String) - Constructor for exception class org.apache.avalon.framework.availability.UnavailableException
-
Constructor.
V
- ValuedEnum - Class in org.apache.avalon.framework
-
Basic enum class for type-safe enums with values.
- ValuedEnum(String, int) - Constructor for class org.apache.avalon.framework.ValuedEnum
-
Constructor for enum item.
- ValuedEnum(String, int, Map) - Constructor for class org.apache.avalon.framework.ValuedEnum
-
Constructor for enum item so that it gets added to Map at creation.
- Version - Class in org.apache.avalon.framework
-
This class is used to hold version information pertaining to a Component or interface.
- Version(int, int, int) - Constructor for class org.apache.avalon.framework.Version
-
Create a new instance of a
Version
object with the specified version numbers.
W
- warn(String) - Method in interface org.apache.avalon.framework.logger.Logger
-
Log a warn message.
- warn(String, Throwable) - Method in interface org.apache.avalon.framework.logger.Logger
-
Log a warn message.
All Classes and Interfaces|All Packages|Serialized Form