Index

A C E G I M N O R S V

A

AbstractInstrument - Class in org.apache.excalibur.instrument: The AbstractInstrument class can be used by an class wishing to implement the Instruement interface.
AbstractInstrument(String) - Constructor for class org.apache.excalibur.instrument.AbstractInstrument: Creates a new AbstractInstrument.
AbstractInstrumentable - Class in org.apache.excalibur.instrument: Utility class to ease the construction of components that can be instrumented.
AbstractInstrumentable() - Constructor for class org.apache.excalibur.instrument.AbstractInstrumentable: Creates a new AbstractInstrumentable.
AbstractLogEnabledInstrumentable - Class in org.apache.excalibur.instrument: Utility class to ease the construction of components that can be instrumented but must also implement LogEnabled.
AbstractLogEnabledInstrumentable() - Constructor for class org.apache.excalibur.instrument.AbstractLogEnabledInstrumentable: Creates a new AbstractLogEnabledInstrumentable.
addChildInstrumentable(Instrumentable) - Method in class org.apache.excalibur.instrument.AbstractInstrumentable: Adds a child Instrumentable to the list of child Instrumentables published by the component.
addChildInstrumentable(Instrumentable) - Method in class org.apache.excalibur.instrument.AbstractLogEnabledInstrumentable: Adds a child Instrumentable to the list of child Instrumentables published by the component.
addInstrument(Instrument) - Method in class org.apache.excalibur.instrument.AbstractInstrumentable: Adds an Instrument to the list of Instruments published by the component.
addInstrument(Instrument) - Method in class org.apache.excalibur.instrument.AbstractLogEnabledInstrumentable: Adds an Instrument to the list of Instruments published by the component.

C

CounterInstrument - Class in org.apache.excalibur.instrument: CounterInstruments can be used to profile the number of times that something happens.
CounterInstrument(String) - Constructor for class org.apache.excalibur.instrument.CounterInstrument: Creates a new CounterInstrument.

E

EMPTY_INSTRUMENT_ARRAY - Static variable in interface org.apache.excalibur.instrument.Instrumentable: Empty Instrument array for use in hierarchical Instrumentable systems.
EMPTY_INSTRUMENTABLE_ARRAY - Static variable in interface org.apache.excalibur.instrument.Instrumentable: Empty Instrumentable array for use in hierarchical Instrumentable systems.

G

getChildInstrumentables() - Method in class org.apache.excalibur.instrument.AbstractInstrumentable: Any Object which implements Instrumentable can also make use of other Instrumentable child objects.
getChildInstrumentables() - Method in class org.apache.excalibur.instrument.AbstractLogEnabledInstrumentable: Any Object which implements Instrumentable can also make use of other Instrumentable child objects.
getChildInstrumentables() - Method in interface org.apache.excalibur.instrument.Instrumentable: Any Object which implements Instrumentable can also make use of other Instrumentable child objects.
getInstrumentableName() - Method in class org.apache.excalibur.instrument.AbstractInstrumentable: Gets the name of the Instrumentable.
getInstrumentableName() - Method in class org.apache.excalibur.instrument.AbstractLogEnabledInstrumentable: Gets the name of the Instrumentable.
getInstrumentableName() - Method in interface org.apache.excalibur.instrument.Instrumentable: Gets the name of the Instrumentable.
getInstrumentName() - Method in class org.apache.excalibur.instrument.AbstractInstrument: Gets the name for the Instrument.
getInstrumentName() - Method in interface org.apache.excalibur.instrument.Instrument: Gets the name for the Instrument.
getInstrumentProxy() - Method in class org.apache.excalibur.instrument.AbstractInstrument: Returns the InstrumentProxy object assigned to the instrument by the InstrumentManager.
getInstruments() - Method in class org.apache.excalibur.instrument.AbstractInstrumentable: Obtain a reference to all the Instruments that the Instrumentable object wishes to expose.
getInstruments() - Method in class org.apache.excalibur.instrument.AbstractLogEnabledInstrumentable: Obtain a reference to all the Instruments that the Instrumentable object wishes to expose.
getInstruments() - Method in interface org.apache.excalibur.instrument.Instrumentable: Obtain a reference to all the Instruments that the Instrumentable object wishes to expose.

I

increment() - Method in class org.apache.excalibur.instrument.CounterInstrument: Increments the Instrument.
increment(int) - Method in class org.apache.excalibur.instrument.CounterInstrument: Increments the Instrument by a specified count.
increment(int) - Method in interface org.apache.excalibur.instrument.InstrumentProxy: Increments the Instrument by a specified count.
Instrument - Interface in org.apache.excalibur.instrument: The Instrument interface must by implemented by any object wishing to act as an instrument used by the instrument manager.
Instrumentable - Interface in org.apache.excalibur.instrument: The Instrumentable interface is to mark objects that can be sampled by an InstrumentManager.
InstrumentManageable - Interface in org.apache.excalibur.instrument: Components which implement the InstrumentManageable Interface will have their InstrumentManager set by the component manager during their initialization phase.
InstrumentManager - Interface in org.apache.excalibur.instrument
InstrumentProxy - Interface in org.apache.excalibur.instrument: Because some components using Instruments will be created in large numbers a way is needed to collect data from the instances of all instances of a component class without maintaining references to Instruments of each instance.
isActive() - Method in class org.apache.excalibur.instrument.AbstractInstrument: Used by classes being profiled so that they can avoid unnecessary code when the data from an Instrument is not being used.
isActive() - Method in interface org.apache.excalibur.instrument.InstrumentProxy: Used by classes being profiles so that they can avoid unnecessary code when the data from a Instrument is not being used.

M

m_childList - Variable in class org.apache.excalibur.instrument.AbstractInstrumentable: Stores the child instrumentables during initialization.
m_childList - Variable in class org.apache.excalibur.instrument.AbstractLogEnabledInstrumentable: Stores the child instrumentables during initialization.
m_instrumentableName - Variable in class org.apache.excalibur.instrument.AbstractInstrumentable: Name of the instrumentable.
m_instrumentableName - Variable in class org.apache.excalibur.instrument.AbstractLogEnabledInstrumentable: Name of the instrumentable.
m_instrumentList - Variable in class org.apache.excalibur.instrument.AbstractInstrumentable: Stores the instruments during initialization.
m_instrumentList - Variable in class org.apache.excalibur.instrument.AbstractLogEnabledInstrumentable: Stores the instruments during initialization.
m_name - Variable in class org.apache.excalibur.instrument.AbstractInstrument: The name of the Instrument.
m_proxy - Variable in class org.apache.excalibur.instrument.AbstractInstrument: Proxy object used to communicate with the InstrumentManager.
m_registered - Variable in class org.apache.excalibur.instrument.AbstractInstrumentable: Flag which is to used to keep track of when the Instrumentable has been registered.
m_registered - Variable in class org.apache.excalibur.instrument.AbstractLogEnabledInstrumentable: Flag which is to used to keep track of when the Instrumentable has been registered.

N

NoopInstrumentManager - Class in org.apache.excalibur.instrument: An InstrumentManager which doesn't do anything.
NoopInstrumentManager() - Constructor for class org.apache.excalibur.instrument.NoopInstrumentManager

O

org.apache.excalibur.instrument - package org.apache.excalibur.instrument

R

registerInstrumentable(Instrumentable, String) - Method in interface org.apache.excalibur.instrument.InstrumentManager: Instrumentable to be registered with the instrument manager.
registerInstrumentable(Instrumentable, String) - Method in class org.apache.excalibur.instrument.NoopInstrumentManager: Instrumentable to be registered with the instrument manager.
ROLE - Static variable in interface org.apache.excalibur.instrument.InstrumentManager

S

setInstrumentableName(String) - Method in class org.apache.excalibur.instrument.AbstractInstrumentable: Sets the name for the Instrumentable.
setInstrumentableName(String) - Method in class org.apache.excalibur.instrument.AbstractLogEnabledInstrumentable: Sets the name for the Instrumentable.
setInstrumentableName(String) - Method in interface org.apache.excalibur.instrument.Instrumentable: Sets the name for the Instrumentable.
setInstrumentManager(InstrumentManager) - Method in interface org.apache.excalibur.instrument.InstrumentManageable: Sets the InstrumentManager for child components.
setInstrumentProxy(InstrumentProxy) - Method in class org.apache.excalibur.instrument.AbstractInstrument: When the InstrumentManager is present, an InstrumentProxy will be set to enable the Instrument to communicate with the InstrumentManager.
setValue(int) - Method in interface org.apache.excalibur.instrument.InstrumentProxy: Sets the current value of the Instrument.
setValue(int) - Method in class org.apache.excalibur.instrument.ValueInstrument: Sets the current value of the Instrument.

V

ValueInstrument - Class in org.apache.excalibur.instrument: Objects implementing Instrumentable can create Instruments with integer values using a ValueInstrument.
ValueInstrument(String) - Constructor for class org.apache.excalibur.instrument.ValueInstrument: Creates a new ValueInstrument.

A C E G I M N O R S V