MonitorRegistry.java

/**
 * Copyright 2013 Netflix, Inc.
 * <p/>
 * 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
 * <p/>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p/>
 * 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.servo;

import com.netflix.servo.monitor.Monitor;

import java.util.Collection;

/**
 * Registry to keep track of objects with
 * {@link com.netflix.servo.annotations.Monitor} annotations.
 */
public interface MonitorRegistry {
  /**
   * The set of registered Monitor objects.
   */
  Collection<Monitor<?>> getRegisteredMonitors();

  /**
   * Register a new monitor in the registry.
   */
  void register(Monitor<?> monitor);

  /**
   * Unregister a Monitor from the registry.
   */
  void unregister(Monitor<?> monitor);

  /**
   * Check whether a monitor has been registerd.
   */
  boolean isRegistered(Monitor<?> monitor);
}