DataDistributionMBean.java

/*
*
* Copyright 2013 Netflix, Inc.
*
* 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.
*
*/
package com.netflix.stats.distribution;


/**
 * Abstract MBean interface for objects that hold information about a distribution
 * of (double) values.  The information includes basic statistics (count, mean,
 * min, max) as well as information about the percentile values for some number
 * of percent values.
 * <p>
 * This interface supports the standard MBean management interface,
 * so implementing classes will support JMX monitoring.
 *
 * @author netflixoss $
 * @version $Revision: $
 */
public interface DataDistributionMBean extends DistributionMBean {

    /**
     * Gets a String representation of the time when this data was produced.
     */
    String getTimestamp();

    /**
     * Gets the time when this data was produced, in milliseconds since the epoch.
     */
    long getTimestampMillis();

    /**
     * Gets the length of time over which the data was collected,
     * in milliseconds.
     */
    long getSampleIntervalMillis();

    /**
     * Gets the number of values used to compute the percentile values.
     * This value may be smaller than the value of {@link #getNumValues}
     * depending on how the percentile values were computed.
     */
    int getSampleSize();

    /**
     * Gets the array of known percentile percents.
     */
    double[] getPercents();

    /**
     * Gets the array of known percentile values.
     */
    double[] getPercentiles();

} // DataDistributionMBean