1 /***
2 * Copyright 2003-2010 Terracotta, Inc.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package net.sf.ehcache.util.counter.sampled;
18
19 import net.sf.ehcache.util.counter.Counter;
20
21 /***
22 * Interface of a sampled counter -- a counter that keeps sampled values
23 *
24 * @author <a href="mailto:asanoujam@terracottatech.com">Abhishek Sanoujam</a>
25 * @since 1.7
26 *
27 */
28 public interface SampledCounter extends Counter {
29 /***
30 * Shutdown this counter
31 */
32 void shutdown();
33
34 /***
35 * Returns the most recent sampled value
36 *
37 * @return Value of the most recent sampled value
38 */
39 TimeStampedCounterValue getMostRecentSample();
40
41 /***
42 * Returns all samples in history
43 *
44 * @return An array containing the TimeStampedCounterValue's
45 */
46 TimeStampedCounterValue[] getAllSampleValues();
47
48 /***
49 * Returns the current value of the counter and resets it to 0
50 *
51 * @return current value of the counter
52 */
53 long getAndReset();
54
55 }