com.gemstone.gemfire.StatisticsType Maven / Gradle / Ivy
Show all versions of gemfire-core Show documentation
/*
* Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you
* may not use this file except in compliance with the License. You
* may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied. See the License for the specific language governing
* permissions and limitations under the License. See accompanying
* LICENSE file.
*/
package com.gemstone.gemfire;
//import com.gemstone.gemfire.internal.Assert;
//import java.io.*;
//import java.util.*;
/**
* Used to describe a logical collection of statistics. These descriptions
* are used to create an instance of {@link Statistics}.
*
*
* To get an instance of this interface use an instance of
* {@link StatisticsFactory}.
*
* @author Darrel Schneider
*
* @since 3.0
*/
public interface StatisticsType {
/**
* Returns the name of this statistics type
*/
public String getName();
/**
* Returns a description of this statistics type
*/
public String getDescription();
/**
* Returns descriptions of the statistics that this statistics type
* gathers together
*/
public StatisticDescriptor[] getStatistics();
/**
* Returns the id of the statistic with the given name in this
* statistics instance.
*
* @throws IllegalArgumentException
* No statistic named name exists in this
* statistics instance.
*/
public int nameToId(String name);
/**
* Returns the descriptor of the statistic with the given name in this
* statistics instance.
*
* @throws IllegalArgumentException
* No statistic named name exists in this
* statistics instance.
*/
public StatisticDescriptor nameToDescriptor(String name);
}