C D E F G I M O P R S U

C

Criteria - class org.apache.avalon.util.factory.impl.Criteria.

A abstract utility class that can be used to simplify the creation of domain specific criteria.

Criteria(Parameter[]) - Constructor for class org.apache.avalon.util.factory.impl.Criteria

Creation of a new criteria instance.

create() - Method in interface org.apache.avalon.util.factory.Factory

Create a new instance of an application.

create(Map) - Method in interface org.apache.avalon.util.factory.Factory

Create a new instance of an application.

createDefaultCriteria() - Method in interface org.apache.avalon.util.factory.Factory

Return a new instance of default criteria for the factory.

D

Defaults - class org.apache.avalon.util.defaults.Defaults.

Gets a set of default property values based on a sequence of default value search components or finders.

Defaults(String[], String[], DefaultsFinder[]) - Constructor for class org.apache.avalon.util.defaults.Defaults

Creates and populates a set of properties

DefaultsFinder - interface org.apache.avalon.util.defaults.DefaultsFinder.

Finds a set of default property values.

discover(Defaults, Properties[], boolean) - Static method in class org.apache.avalon.util.defaults.Defaults

Merges a set of properties from source Properties into a Defaults instance.

discover(String, Properties[], boolean) - Static method in class org.apache.avalon.util.defaults.Defaults

Discovers a value within a set of Properties either halting on the first time the property is discovered or continuing on to take the last value found for the property key.

E

Env - class org.apache.avalon.util.env.Env.

Encapsulates operating system and shell specific access to environment variables.

Env() - Constructor for class org.apache.avalon.util.env.Env

Creates a snapshot of the current shell environment variables for a user.

EnvAccessException - exception org.apache.avalon.util.env.EnvAccessException.

A simple wrapper exception around exceptions that could occur while accessing environment parameters.

ExceptionHelper - class org.apache.avalon.util.exception.ExceptionHelper.

General utilities supporting the packaging of exception messages.

ExceptionHelper() - Constructor for class org.apache.avalon.util.exception.ExceptionHelper

F

Factory - interface org.apache.avalon.util.factory.Factory.

A generic application factory.

FactoryException - exception org.apache.avalon.util.factory.FactoryException.

Exception to indicate that there was a repository related error.

FactoryException(String) - Constructor for class org.apache.avalon.util.factory.FactoryException

Construct a new FactoryException instance.

FactoryException(String, Throwable) - Constructor for class org.apache.avalon.util.factory.FactoryException

Construct a new FactoryException instance.

FactoryRuntimeException - exception org.apache.avalon.util.factory.FactoryRuntimeException.

Exception to indicate that there was a repository related error.

FactoryRuntimeException(String) - Constructor for class org.apache.avalon.util.factory.FactoryRuntimeException

Construct a new FactoryRuntimeException instance.

FactoryRuntimeException(String, Throwable) - Constructor for class org.apache.avalon.util.factory.FactoryRuntimeException

Construct a new FactoryRuntimeException instance.

find(Defaults) - Method in interface org.apache.avalon.util.defaults.DefaultsFinder

find(Defaults) - Method in class org.apache.avalon.util.defaults.SimpleDefaultsFinder

Applies default discovery using properties in array of properties.

G

get(Object) - Method in class org.apache.avalon.util.factory.impl.Criteria

Return the currently assigned value for a key.

getBoolean(String) - Method in class org.apache.avalon.util.defaults.Defaults

Utility method that gets a key's value and returns a boolean value to represent it.

getCause() - Method in class org.apache.avalon.util.env.EnvAccessException

Return the causal exception.

getCause() - Method in class org.apache.avalon.util.factory.FactoryException

Return the causal exception.

getCause() - Method in class org.apache.avalon.util.factory.FactoryRuntimeException

Return the causal exception.

getDefault() - Method in class org.apache.avalon.util.factory.impl.Parameter

Return the default value for this parameter.

getEnumerated() - Method in class org.apache.avalon.util.defaults.Defaults

Gets the base names of enumerated multi-valued keys.

getEnumerated(String) - Method in class org.apache.avalon.util.defaults.Defaults

Gets the default values for an enumerated key.

getEnvVariable(String) - Static method in class org.apache.avalon.util.env.Env

Gets the value of a shell environment variable.

getEnvVariables() - Static method in class org.apache.avalon.util.env.Env

Gets all environment variables within a Properties instance where the key is the environment variable name and value is the value of the property.

getFinders() - Method in class org.apache.avalon.util.defaults.Defaults

Gets the linear set of finders composing the search policy.

getKey() - Method in class org.apache.avalon.util.factory.impl.Parameter

Return the key for the parameter.

getKeys(Parameter[]) - Static method in class org.apache.avalon.util.factory.impl.Parameter

Return the set of keys corresponding to the supplied set of parameters.

getMessage() - Method in class org.apache.avalon.util.env.EnvAccessException

Prepends variable name to the base message.

getParameter(String) - Method in class org.apache.avalon.util.factory.impl.Criteria

getParameterClass() - Method in class org.apache.avalon.util.factory.impl.Parameter

Return the classname for the parameter.

getParameters() - Method in class org.apache.avalon.util.factory.impl.Criteria

Return the parameter associated to the criteria.

getSingles() - Method in class org.apache.avalon.util.defaults.Defaults

Gets the names of all the single valued properties.

getStaticProperties(Class, String) - Static method in class org.apache.avalon.util.defaults.Defaults

Read in a static properties resource relative to a supplied class and path.

getUserShell() - Static method in class org.apache.avalon.util.env.Env

Gets the user's shell executable.

getValue(Parameter) - Method in class org.apache.avalon.util.factory.impl.Criteria

Return the currently assigned value for a key.

getVariable() - Method in class org.apache.avalon.util.env.EnvAccessException

Gets the variable that was to be accessed.

I

isOptional() - Method in class org.apache.avalon.util.factory.impl.Parameter

Return TRUE is the parameter is optional.

isRequired() - Method in class org.apache.avalon.util.factory.impl.Parameter

Return TRUE is the parameter is required.

isUnix() - Static method in class org.apache.avalon.util.env.Env

Checks to see if the operating system is a UNIX variant.

isWindows() - Static method in class org.apache.avalon.util.env.Env

Checks to see if the operating system is a Windows variant.

M

m_cause - Variable in class org.apache.avalon.util.env.EnvAccessException

root cause

m_variable - Variable in class org.apache.avalon.util.env.EnvAccessException

the environment variable name if available

macroExpand(Properties, Properties[]) - Static method in class org.apache.avalon.util.defaults.Defaults

Expands out a set of property key macros in the following format ${foo.bar} where foo.bar is a property key, by dereferencing the value of the key using the original source Properties and other optional Properties.

O

OSNAME - Static variable in class org.apache.avalon.util.env.Env

os.name System property

org.apache.avalon.util.defaults - package org.apache.avalon.util.defaults

Provides support for the aggregation of a set of property values into a single property set.

org.apache.avalon.util.env - package org.apache.avalon.util.env

Contains a specialized properties object that handles establishment of operationg system specific environment variables as property values.

org.apache.avalon.util.exception - package org.apache.avalon.util.exception

Contains an exception helper static utility class that provides support for the creation of exception reposrt derived from cascading exception.

org.apache.avalon.util.factory - package org.apache.avalon.util.factory

The factory api package defines a generic factory interface.

org.apache.avalon.util.factory.impl - package org.apache.avalon.util.factory.impl

The factory impl package provides a parameterized map implementation that can be used to simplfy the creation and management of factory criteria.

P

Parameter - class org.apache.avalon.util.factory.impl.Parameter.

A parameter is an immutable class that contains a description of an allowable parameter within a crieria instance.

Parameter(String, Class) - Constructor for class org.apache.avalon.util.factory.impl.Parameter

Creation of a new required parameter constraint.

Parameter(String, Class, Object) - Constructor for class org.apache.avalon.util.factory.impl.Parameter

Creation of a new optional parameter constraint.

packException(Throwable) - Static method in class org.apache.avalon.util.exception.ExceptionHelper

Returns the exception and causal exceptions as a formatted string.

packException(Throwable, boolean) - Static method in class org.apache.avalon.util.exception.ExceptionHelper

Returns the exception and causal exceptions as a formatted string.

packException(String, Throwable) - Static method in class org.apache.avalon.util.exception.ExceptionHelper

Returns the exception and causal exceptions as a formatted string.

packException(String, Throwable, boolean) - Static method in class org.apache.avalon.util.exception.ExceptionHelper

Returns the exception and causal exceptions as a formatted string.

packException(String, Throwable[], boolean) - Static method in class org.apache.avalon.util.exception.ExceptionHelper

Returns the exception and causal exceptions as a formatted string.

put(Object, Object) - Method in class org.apache.avalon.util.factory.impl.Criteria

Set a named parameter of the criteria to a value.

R

resolve(Object) - Method in class org.apache.avalon.util.factory.impl.Parameter

Resolve a supplied argument to a value.

S

SimpleDefaultsFinder - class org.apache.avalon.util.defaults.SimpleDefaultsFinder.

Attempts to discover defaults using an array of Properties as value sources.

SimpleDefaultsFinder(Properties) - Constructor for class org.apache.avalon.util.defaults.SimpleDefaultsFinder

Creates a simple defaults finder that searches a single source Properties instance for default values.

SimpleDefaultsFinder(Properties[], boolean) - Constructor for class org.apache.avalon.util.defaults.SimpleDefaultsFinder

Creates a simple defaults filder that searches a set of source Properties for default values.

SystemDefaultsFinder - class org.apache.avalon.util.defaults.SystemDefaultsFinder.

Finds default property values within the system properties.

SystemDefaultsFinder() - Constructor for class org.apache.avalon.util.defaults.SystemDefaultsFinder

Finds default property values within the system properties.

U

USERNAME - Static variable in class org.apache.avalon.util.env.Env

user.name System property

C D E F G I M O P R S U