com.gemstone.gemfire.internal.statistics.StatisticsNotification Maven / Gradle / Ivy

/*
 * Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
 *
 * 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. See accompanying
 * LICENSE file.
 */
package com.gemstone.gemfire.internal.statistics;

import java.util.Iterator;

import com.gemstone.gemfire.StatisticDescriptor;
import com.gemstone.gemfire.Statistics;
import com.gemstone.gemfire.StatisticsType;

/**
 * @author Kirk Lund
 * @since 7.0
 */
public interface StatisticsNotification extends Iterable {
  
  public static enum Type {
    /** CounterMonitor threshold was exceeded */
    THRESHOLD_VALUE_EXCEEDED,
    /** GaugeMonitor low-threshold was exceeded */
    THRESHOLD_LOW_VALUE_EXCEEDED,
    /** GaugeMonitor high-threshold was exceeded */
    THRESHOLD_HIGH_VALUE_EXCEEDED,
    /** ValueMonitor expected value was matched */
    VALUE_MATCHED,
    /** ValueMonitor expected value was differed */
    VALUE_DIFFERED,
    /** ValueMonitor value(s) changed */
    VALUE_CHANGED
  }

  /** Returns the timestamp of the stat sample */
  public long getTimeStamp();

  /** Returns the notification type */
  public Type getType();

  /** Returns an iterator of all the stat instances that met the monitor's criteria */
  public Iterator iterator();

  /** Returns an iterator of all the stat instances for the specified descriptor that met the monitor's criteria */
  public Iterator iterator(StatisticDescriptor statDesc);

  /** Returns an iterator of all the stat instances for the specified statistics instance that met the monitor's criteria */
  public Iterator iterator(Statistics statistics);

  /** Returns an iterator of all the stat instances for the specified statistics type that met the monitor's criteria */
  public Iterator iterator(StatisticsType statisticsType);

  /** Returns the value for the specified stat instance */
  public Number getValue(StatisticId statId) throws StatisticNotFoundException;
}