001package org.apache.commons.jcs.engine.stats.behavior;
002
003import java.util.List;
004
005/*
006 * Licensed to the Apache Software Foundation (ASF) under one
007 * or more contributor license agreements.  See the NOTICE file
008 * distributed with this work for additional information
009 * regarding copyright ownership.  The ASF licenses this file
010 * to you under the Apache License, Version 2.0 (the
011 * "License"); you may not use this file except in compliance
012 * with the License.  You may obtain a copy of the License at
013 *
014 *   http://www.apache.org/licenses/LICENSE-2.0
015 *
016 * Unless required by applicable law or agreed to in writing,
017 * software distributed under the License is distributed on an
018 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
019 * KIND, either express or implied.  See the License for the
020 * specific language governing permissions and limitations
021 * under the License.
022 */
023
024/**
025 * This holds stat information on a region. It contains both auxiliary and core stats.
026 */
027public interface ICacheStats
028    extends IStats
029{
030    /**
031     * Stats are for a region, though auxiliary data may be for more.
032     * <p>
033     * @return The region name
034     */
035    String getRegionName();
036
037    /**
038     * @param name
039     */
040    void setRegionName( String name );
041
042    /**
043     * @return IStats[]
044     */
045    List<IStats> getAuxiliaryCacheStats();
046
047    /**
048     * @param stats
049     */
050    void setAuxiliaryCacheStats( List<IStats> stats );
051}