KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > excalibur > instrument > manager > CounterInstrumentSample


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;
51
52 import org.apache.avalon.framework.configuration.Configuration;
53 import org.apache.avalon.framework.configuration.ConfigurationException;
54 import org.apache.excalibur.instrument.manager.interfaces.InstrumentManagerClient;
55
56 /**
57  * A InstrumentSample which stores the number of times that increment has been
58  * called during the sample period.
59  *
60  * @author <a HREF="mailto:leif@tanukisoftware.com">Leif Mortenson</a>
61  * @version CVS $Revision: 1.3 $ $Date: 2003/02/25 16:28:16 $
62  * @since 4.1
63  */
64 class CounterInstrumentSample
65     extends AbstractInstrumentSample
66     implements CounterInstrumentListener
67 {
68     /** The count. */
69     protected int m_count;
70     
71     /*---------------------------------------------------------------
72      * Constructors
73      *-------------------------------------------------------------*/
74     /**
75      * Creates a new CounterInstrumentSample
76      *
77      * @param instrumentProxy The InstrumentProxy which owns the
78      * InstrumentSample.
79      * @param name The name of the new InstrumentSample.
80      * @param interval The sample interval of the new InstrumentSample.
81      * @param size The number of samples to store as history. Assumes that size is at least 1.
82      * @param description The description of the new InstrumentSample.
83      * @param lease The length of the lease in milliseconds.
84      */
85     CounterInstrumentSample( InstrumentProxy instrumentProxy,
86                              String JavaDoc name,
87                              long interval,
88                              int size,
89                              String JavaDoc description,
90                              long lease )
91     {
92         super( instrumentProxy, name, interval, size, description, lease );
93         
94         // Set the current value to 0 initially.
95 m_count = 0;
96     }
97     
98     /*---------------------------------------------------------------
99      * InstrumentSample Methods
100      *-------------------------------------------------------------*/
101     /**
102      * Returns the type of the Instrument Sample.
103      *
104      * @return The type of the Instrument Sample.
105      */
106     public int getType()
107     {
108         return InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_COUNTER;
109     }
110     
111     /**
112      * Returns the Type of the Instrument which can use the sample. This
113      * should be the same for all instances of a class.
114      * <p>
115      * This InstrumentSample returns InstrumentManager.PROFILE_POINT_TYPE_COUNTER
116      *
117      * @return The Type of the Instrument which can use the sample.
118      */
119     public final int getInstrumentType()
120     {
121         return InstrumentManagerClient.INSTRUMENT_TYPE_COUNTER;
122     }
123     
124     /**
125      * Obtain the value of the sample. All samples are integers, so the profiled
126      * objects must measure quantity (numbers of items), rate (items/period), time in
127      * milliseconds, etc.
128      *
129      * @return The sample value.
130      */
131     public int getValueInner()
132     {
133         return m_count;
134     }
135     
136     /*---------------------------------------------------------------
137      * AbstractInstrumentSample Methods
138      *-------------------------------------------------------------*/
139     /**
140      * The current sample has already been stored. Reset the current sample
141      * and move on to the next.
142      * <p>
143      * Should only be called when synchronized.
144      */
145     protected void advanceToNextSample()
146     {
147         // Counts do not propagate, so always reset the count to 0.
148 m_count = 0;
149     }
150     
151     /**
152      * Used to load the state, called from AbstractInstrumentSample.loadState();
153      * <p>
154      * Should only be called when synchronized.
155      *
156      * @param value Current value loaded from the state.
157      * @param state Configuration object to load state from.
158      *
159      * @throws ConfigurationException If there were any problems loading the
160      * state.
161      */
162     protected void loadState( int value, Configuration state )
163         throws ConfigurationException
164     {
165         m_count = value;
166     }
167     
168     /**
169      * Called after a state is loaded if the sample period is not the same
170      * as the last period saved.
171      */
172     protected void postSaveNeedsReset()
173     {
174         m_count = 0;
175     }
176     
177     /*---------------------------------------------------------------
178      * CounterInstrumentListener Methods
179      *-------------------------------------------------------------*/
180     /**
181      * Called by a CounterInstrument whenever its value is incremented.
182      *
183      * @param instrumentName The name of Instrument which was incremented.
184      * @param count A positive integer to increment the counter by.
185      * @param time The time that the Instrument was incremented.
186      */
187     public void increment( String JavaDoc instrumentName, int count, long time )
188     {
189         //System.out.println("CounterInstrumentSample.increment(" + instrumentName + ", " + count + ", " + time + ") : " + getName() );
190 increment( count, time );
191     }
192     
193     /*---------------------------------------------------------------
194      * Methods
195      *-------------------------------------------------------------*/
196     /**
197      * Increments the count.
198      *
199      * @param time Time that the count is incremented.
200      * @param count A positive integer to increment the counter by.
201      */
202     private void increment( int count, long time )
203     {
204         int sampleValue;
205         long sampleTime;
206         
207         synchronized(this)
208         {
209             update( time );
210             
211             m_count += count;
212             
213             sampleValue = m_count;
214             sampleTime = m_time;
215         }
216         
217         updateListeners( sampleValue, sampleTime );
218     }
219 }
220
Popular Tags