core/api/src/main/java/org/apache/polygene/api/metrics/MetricsTimerFactory.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.polygene.api.metrics;

/**
 * Create MetricsTimer instances.
 */
public interface MetricsTimerFactory extends MetricsFactory
{
    /**
     * Create a MetricsTimer instance.
     * If the same arguments are given twice, the same instance must be returned.
     *
     * @param name     A human readable, short name of the metric.
     *
     * @return A Metric instance to be used, OR org.apache.polygene.spi.metrics.DefaultMetric.NULL if not supported.
     *
     */
    MetricsTimer createTimer( String name );
}