View Javadoc

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  /***
23   * IAuxiliaryCacheStats will hold these IStatElements.
24   *
25   * @author aaronsm
26   *
27   */
28  public interface IStatElement
29  {
30  
31      /***
32       * Get the name of the stat element, ex. HitCount
33       *
34       * @return the stat element name
35       */
36      public abstract String getName();
37  
38      /***
39       *
40       * @param name
41       */
42      public abstract void setName( String name );
43  
44      /***
45       * Get the data, ex. for hit count you would get a String value for some
46       * number.
47       *
48       * @return String data
49       */
50      public abstract String getData();
51  
52      /***
53       * Set the data for this element.
54       *
55       * @param data
56       */
57      public abstract void setData( String data );
58  
59  }