1 package org.apache.jcs.engine.stats.behavior;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.io.Serializable;
23
24 /**
25 * This interface defines the common behavior for a stats holder.
26 *
27 * @author aaronsm
28 *
29 */
30 public interface IStats
31 extends Serializable
32 {
33
34 /**
35 * Return generic statistical or historical data.
36 *
37 * @return IStatElement[]
38 */
39 public abstract IStatElement[] getStatElements();
40
41 /**
42 * Set the generic statistical or historical data.
43 *
44 * @param stats
45 */
46 public abstract void setStatElements( IStatElement[] stats );
47
48 /**
49 * Get the type name, such as "LRU Memory Cache." No formal type is defined.
50 *
51 * @return String
52 */
53 public abstract String getTypeName();
54
55 /**
56 * Set the type name, such as "LRU Memory Cache." No formal type is defined.
57 * If we need formal types, we can use the cachetype param
58 *
59 * @param name
60 */
61 public abstract void setTypeName( String name );
62 }