001    package org.apache.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    
022    import java.io.Serializable;
023    
024    /**
025     * This interface defines the common behavior for a stats holder.
026     *
027     * @author aaronsm
028     *
029     */
030    public interface IStats
031        extends Serializable
032    {
033    
034        /**
035         * Return generic statistical or historical data.
036         *
037         * @return IStatElement[]
038         */
039        public abstract IStatElement[] getStatElements();
040    
041        /**
042         * Set the generic statistical or historical data.
043         *
044         * @param stats
045         */
046        public abstract void setStatElements( IStatElement[] stats );
047    
048        /**
049         * Get the type name, such as "LRU Memory Cache." No formal type is defined.
050         *
051         * @return String
052         */
053        public abstract String getTypeName();
054    
055        /**
056         * Set the type name, such as "LRU Memory Cache." No formal type is defined.
057         * If we need formal types, we can use the cachetype param
058         *
059         * @param name
060         */
061        public abstract void setTypeName( String name );
062    }