src/java/org/apache/cassandra/metrics/ClearableHistogram.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.cassandra.metrics;

import com.google.common.annotations.VisibleForTesting;

import com.codahale.metrics.Histogram;

/**
 * Adds ability to reset a histogram
 */
public class ClearableHistogram extends Histogram
{
    private final DecayingEstimatedHistogramReservoir reservoirRef;

    /**
     * Creates a new {@link com.codahale.metrics.Histogram} with the given reservoir.
     *
     * @param reservoir the reservoir to create a histogram from
     */
    public ClearableHistogram(DecayingEstimatedHistogramReservoir reservoir)
    {
        super(reservoir);

        this.reservoirRef = reservoir;
    }

    @VisibleForTesting
    public void clear()
    {
        reservoirRef.clear();
    }
}