org.eclipse.microprofile.metrics.Counter Maven / Gradle / Ivy
/*
**********************************************************************
* Copyright (c) 2017 Contributors to the Eclipse Foundation
* 2010-2013 Coda Hale, Yammer.com
*
* See the NOTICES file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* 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.
*
* SPDX-License-Identifier: Apache-2.0
**********************************************************************/
package org.eclipse.microprofile.metrics;
/**
* An incrementing counter metric.
*/
public interface Counter extends Metric, Counting {
/**
* Increment the counter by one.
*/
void inc();
/**
* Increment the counter by {@code n}.
*
* @param n
* the amount by which the counter will be increased
*/
void inc(long n);
/**
* Returns the counter's current value.
*
* @return the counter's current value
*/
@Override
long getCount();
}