KickJava   Java API By Example, From Geeks To Geeks.

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


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 import java.io.Serializable JavaDoc;
53
54 /**
55  *
56  * @author <a HREF="mailto:leif@tanukisoftware.com">Leif Mortenson</a>
57  * @version CVS $Revision: 1.3 $ $Date: 2003/02/20 17:08:19 $
58  * @since 4.1
59  */

60 public class InstrumentSampleSnapshot
61     implements Serializable JavaDoc
62 {
63     static final long serialVersionUID = -3284372358291073513L;
64     
65     /** The name used to reference the InstrumentSample. */
66     private String JavaDoc m_InstrumentSampleName;
67     
68     /** The interval between each sample. */
69     private long m_interval;
70     
71     /** The number of samples in the InstrumentSample. */
72     private int m_size;
73     
74     /** The time that the last sample starts. */
75     private long m_time;
76     
77     /** The samples as an array of integers. */
78     private int[] m_samples;
79     
80     /** State Version. */
81     private int m_stateVersion;
82     
83     /*---------------------------------------------------------------
84      * Constructors
85      *-------------------------------------------------------------*/

86     /**
87      * @param InstrumentSampleName The name used to reference the InstrumentSample.
88      * @param interval The interval between each sample.
89      * @param size The number of samples in the InstrumentSample.
90      * @param time The time that the last sample starts.
91      * @param samples The samples as an array of integers.
92      * @param stateVersion The current state version of the sample.
93      */

94     public InstrumentSampleSnapshot( String JavaDoc InstrumentSampleName,
95                            long interval,
96                            int size,
97                            long time,
98                            int[] samples,
99                            int stateVersion )
100     {
101         m_InstrumentSampleName = InstrumentSampleName;
102         m_interval = interval;
103         m_size = size;
104         m_time = time;
105         m_samples = samples;
106         m_stateVersion = stateVersion;
107     }
108     
109     /*---------------------------------------------------------------
110      * Methods
111      *-------------------------------------------------------------*/

112     /**
113      * Returns the name used to reference the InstrumentSample.
114      *
115      * @return The name used to reference the InstrumentSample.
116      */

117     public String JavaDoc getInstrumentSampleName()
118     {
119         return m_InstrumentSampleName;
120     }
121     
122     /**
123      * Returns the interval, in milliseconds, between each sample.
124      *
125      * @return The interval between each sample.
126      */

127     public long getInterval()
128     {
129         return m_interval;
130     }
131     
132     /**
133      * Returns the number of samples in the InstrumentSample.
134      *
135      * @return The number of samples in the InstrumentSample.
136      */

137     public int getSize()
138     {
139         return m_size;
140     }
141     
142     /**
143      * Returns the time that the last sample starts.
144      *
145      * @return The time that the last sample starts.
146      */

147     public long getTime()
148     {
149         return m_time;
150     }
151     
152     /**
153      * Returns the samples as an array of integers. The sample at index 0
154      * will be the oldest. The end of the array is the newest.
155      *
156      * @return The samples as an array of integers.
157      */

158     public int[] getSamples()
159     {
160         return m_samples;
161     }
162     
163     /**
164      * Returns the stateVersion of the sample. The state version will be
165      * incremented each time any of the configuration of the sample is
166      * modified.
167      * Clients can use this value to tell whether or not anything has
168      * changed without having to do an exhaustive comparison.
169      *
170      * @return The state version of the sample.
171      */

172     public int getStateVersion()
173     {
174         return m_stateVersion;
175     }
176 }
177
178
Popular Tags