001package org.apache.commons.jcs.engine.stats.behavior;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.io.Serializable;
023import java.util.List;
024
025/**
026 * This interface defines the common behavior for a stats holder.
027 *
028 * @author aaronsm
029 *
030 */
031public interface IStats
032    extends Serializable
033{
034
035    /**
036     * Return generic statistical or historical data.
037     *
038     * @return list of IStatElements
039     */
040    List<IStatElement<?>> getStatElements();
041
042    /**
043     * Set the generic statistical or historical data.
044     *
045     * @param stats
046     */
047    void setStatElements( List<IStatElement<?>> stats );
048
049    /**
050     * Get the type name, such as "LRU Memory Cache." No formal type is defined.
051     *
052     * @return String
053     */
054    String getTypeName();
055
056    /**
057     * Set the type name, such as "LRU Memory Cache." No formal type is defined.
058     * If we need formal types, we can use the cachetype param
059     *
060     * @param name
061     */
062    void setTypeName( String name );
063}