1 package org.apache.commons.jcs3.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 import java.util.List;
24
25 /**
26 * This interface defines the common behavior for a stats holder.
27 */
28 public interface IStats
29 extends Serializable
30 {
31
32 /**
33 * Return generic statistical or historical data.
34 *
35 * @return list of IStatElements
36 */
37 List<IStatElement<?>> getStatElements();
38
39 /**
40 * Set the generic statistical or historical data.
41 *
42 * @param stats
43 */
44 void setStatElements( List<IStatElement<?>> stats );
45
46 /**
47 * Get the type name, such as "LRU Memory Cache." No formal type is defined.
48 *
49 * @return String
50 */
51 String getTypeName();
52
53 /**
54 * Set the type name, such as "LRU Memory Cache." No formal type is defined.
55 * If we need formal types, we can use the cachetype param
56 *
57 * @param name
58 */
59 void setTypeName( String name );
60 }