org.apache.excalibur.instrument
Interface Instrument

All Known Implementing Classes:

AbstractInstrument

public interface Instrument

The Instrument interface must by implemented by any object wishing to act as an instrument used by the instrument manager.

Since:

4.1

Version:

CVS $Revision: 1.4 $ $Date: 2004/02/28 11:47:28 $

Author:

Avalon Development Team

Method Summary

java.lang.String

getInstrumentName() Gets the name for the Instrument.

Method Detail

getInstrumentName

public java.lang.String getInstrumentName()

Gets the name for the Instrument. When an Instrumentable publishes more than one Instrument, this name makes it possible to identify each Instrument. The value should be a string which does not contain spaces or periods.

Returns:

The name of the Instrument.