Keel 2.1RC2

org.apache.excalibur.instrument.manager
Interface InstrumentableDescriptorLocal

All Superinterfaces:
InstrumentableDescriptor
All Known Implementing Classes:
InstrumentableDescriptorLocalImpl

public interface InstrumentableDescriptorLocal
extends InstrumentableDescriptor

Describes a Instrumentable and acts as a Proxy to protect the original Instrumentable. Methods defined by the Local interface should only be accessed from within the same JVM for performance reasons.

Since:
4.1
Version:
CVS $Revision: 1.4 $ $Date: 2004/02/28 11:47:25 $
Author:

Method Summary
 InstrumentableDescriptorLocal getChildInstrumentableDescriptorLocal(java.lang.String childInstrumentableName)
          Returns a child InstrumentableDescriptorLocal based on its name or the name of any of its children.
 InstrumentableDescriptorLocal[] getChildInstrumentableDescriptorLocals()
          Returns an array of Descriptors for the child Instrumentables registered by this Instrumentable.
 InstrumentDescriptorLocal getInstrumentDescriptorLocal(java.lang.String instrumentName)
          Returns a InstrumentDescriptorLocal based on its name.
 InstrumentDescriptorLocal[] getInstrumentDescriptorLocals()
          Returns an array of Descriptors for the Instruments registered by this Instrumentable.
 InstrumentableDescriptorLocal getParentInstrumentableDescriptorLocal()
          Returns the parent InstrumentableDescriptorLocal or null if this is a top level instrumentable.
 
Methods inherited from interface org.apache.excalibur.instrument.manager.interfaces.InstrumentableDescriptor
getChildInstrumentableDescriptor, getChildInstrumentableDescriptors, getDescription, getInstrumentDescriptor, getInstrumentDescriptors, getName, getParentInstrumentableDescriptor, getStateVersion, isConfigured, isRegistered
 

Method Detail

getParentInstrumentableDescriptorLocal

public InstrumentableDescriptorLocal getParentInstrumentableDescriptorLocal()
Returns the parent InstrumentableDescriptorLocal or null if this is a top level instrumentable.

Returns:
The parent InstrumentableDescriptorLocal or null.

getChildInstrumentableDescriptorLocal

public InstrumentableDescriptorLocal getChildInstrumentableDescriptorLocal(java.lang.String childInstrumentableName)
                                                                    throws NoSuchInstrumentableException
Returns a child InstrumentableDescriptorLocal based on its name or the name of any of its children.

Parameters:
childInstrumentableName - Name of the child Instrumentable being requested.
Returns:
A descriptor of the requested child Instrumentable.
Throws:
NoSuchInstrumentableException - If the specified Instrumentable does not exist.

getChildInstrumentableDescriptorLocals

public InstrumentableDescriptorLocal[] getChildInstrumentableDescriptorLocals()
Returns an array of Descriptors for the child Instrumentables registered by this Instrumentable.

Returns:
An array of Descriptors for the child Instrumentables registered by this Instrumentable.

getInstrumentDescriptorLocal

public InstrumentDescriptorLocal getInstrumentDescriptorLocal(java.lang.String instrumentName)
                                                       throws NoSuchInstrumentException
Returns a InstrumentDescriptorLocal based on its name.

Parameters:
instrumentName - Name of the Instrument being requested.
Returns:
A Descriptor of the requested Instrument.
Throws:
NoSuchInstrumentException - If the specified Instrument does not exist.

getInstrumentDescriptorLocals

public InstrumentDescriptorLocal[] getInstrumentDescriptorLocals()
Returns an array of Descriptors for the Instruments registered by this Instrumentable.

Returns:
An array of Descriptors for the Instruments registered by this Instrumentable.

Keel 2.1RC2

Please see keelframework.org for information about new Keel releases.