KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > excalibur > instrument > manager > interfaces > InstrumentableDescriptor


1 /*
2
3  ============================================================================
4                    The Apache Software License, Version 1.1
5  ============================================================================
6  
7  Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
8  
9  Redistribution and use in source and binary forms, with or without modifica-
10  tion, are permitted provided that the following conditions are met:
11  
12  1. Redistributions of source code must retain the above copyright notice,
13     this list of conditions and the following disclaimer.
14  
15  2. Redistributions in binary form must reproduce the above copyright notice,
16     this list of conditions and the following disclaimer in the documentation
17     and/or other materials provided with the distribution.
18  
19  3. The end-user documentation included with the redistribution, if any, must
20     include the following acknowledgment: "This product includes software
21     developed by the Apache Software Foundation (http://www.apache.org/)."
22     Alternately, this acknowledgment may appear in the software itself, if
23     and wherever such third-party acknowledgments normally appear.
24  
25  4. The names "Jakarta", "Avalon", "Excalibur" and "Apache Software Foundation"
26     must not be used to endorse or promote products derived from this software
27     without prior written permission. For written permission, please contact
28     apache@apache.org.
29  
30  5. Products derived from this software may not be called "Apache", nor may
31     "Apache" appear in their name, without prior written permission of the
32     Apache Software Foundation.
33  
34  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44  
45  This software consists of voluntary contributions made by many individuals
46  on behalf of the Apache Software Foundation. For more information on the
47  Apache Software Foundation, please see <http://www.apache.org/>.
48  
49 */
50 package org.apache.excalibur.instrument.manager.interfaces;
51
52 /**
53  * Describes a Instrumentable and acts as a Proxy to protect the original
54  * Instrumentable.
55  *
56  * @author <a HREF="mailto:leif@tanukisoftware.com">Leif Mortenson</a>
57  * @version CVS $Revision: 1.3 $ $Date: 2003/02/20 17:08:20 $
58  * @since 4.1
59  */
60 public interface InstrumentableDescriptor
61 {
62     /**
63      * Returns true if the Instrumentable was configured in the instrumentables
64      * section of the configuration.
65      *
66      * @return True if configured.
67      */
68     boolean isConfigured();
69
70     /**
71      * Returns true if the Instrumentable was registered with the Instrument
72      * Manager.
73      *
74      * @return True if registered.
75      */
76     boolean isRegistered();
77
78     /**
79      * Gets the name for the Instrumentable. The Instrumentable Name is used to
80      * uniquely identify the Instrumentable during the configuration of the
81      * Profiler and to gain access to a InstrumentableDescriptor through a
82      * ProfilerManager.
83      *
84      * @return The name used to identify a Instrumentable.
85      */
86     String JavaDoc getName();
87
88     /**
89      * Gets the description of the Instrumentable.
90      *
91      * @return The description of the Instrumentable.
92      */
93     String JavaDoc getDescription();
94
95     /**
96      * Returns a child InstrumentableDescriptor based on its name or the name
97      * of any of its children.
98      *
99      * @param childInstrumentableName Name of the child Instrumentable being
100      * requested.
101      *
102      * @return A descriptor of the requested child Instrumentable.
103      *
104      * @throws NoSuchInstrumentableException If the specified Instrumentable
105      * does not exist.
106      */
107     InstrumentableDescriptor getChildInstrumentableDescriptor( String JavaDoc childInstrumentableName )
108         throws NoSuchInstrumentableException;
109
110     /**
111      * Returns an array of Descriptors for the child Instrumentables registered
112      * by this Instrumentable.
113      *
114      * @return An array of Descriptors for the child Instrumentables registered
115      * by this Instrumentable.
116      */
117     InstrumentableDescriptor[] getChildInstrumentableDescriptors();
118         
119     /**
120      * Returns a InstrumentDescriptor based on its name.
121      *
122      * @param instrumentName Name of the Instrument being requested.
123      *
124      * @return A Descriptor of the requested Instrument.
125      *
126      * @throws NoSuchInstrumentException If the specified Instrument does
127      * not exist.
128      */
129     InstrumentDescriptor getInstrumentDescriptor( String JavaDoc instrumentName )
130         throws NoSuchInstrumentException;
131
132     /**
133      * Returns an array of Descriptors for the Instruments registered by this
134      * Instrumentable.
135      *
136      * @return An array of Descriptors for the Instruments registered by this
137      * Instrumentable.
138      */
139     InstrumentDescriptor[] getInstrumentDescriptors();
140     
141     /**
142      * Returns the stateVersion of the instrumentable. The state version
143      * will be incremented each time any of the configuration of the
144      * instrumentable or any of its children is modified.
145      * Clients can use this value to tell whether or not anything has
146      * changed without having to do an exhaustive comparison.
147      *
148      * @return The state version of the instrumentable.
149      */
150     int getStateVersion();
151 }
152
Popular Tags