001package org.apache.commons.jcs3.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 */
028public interface IStats
029    extends Serializable
030{
031
032    /**
033     * Return generic statistical or historical data.
034     *
035     * @return list of IStatElements
036     */
037    List<IStatElement<?>> getStatElements();
038
039    /**
040     * Set the generic statistical or historical data.
041     *
042     * @param stats
043     */
044    void setStatElements( List<IStatElement<?>> stats );
045
046    /**
047     * Get the type name, such as "LRU Memory Cache." No formal type is defined.
048     *
049     * @return String
050     */
051    String getTypeName();
052
053    /**
054     * Set the type name, such as "LRU Memory Cache." No formal type is defined.
055     * If we need formal types, we can use the cachetype param
056     *
057     * @param name
058     */
059    void setTypeName( String name );
060}