org.quartz.utils.counter.sampled.SampledCounterConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sundial Show documentation

A Lightweight Java Job Scheduling Framework

There is a newer version: 2.0.1

/**
 *  Copyright 2003-2009 Terracotta, Inc.
 *
 *  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.
 */

package org.quartz.utils.counter.sampled;

import org.quartz.utils.counter.Counter;
import org.quartz.utils.counter.CounterConfig;

/**
 * Config for a {@link SampledCounter}
 * 
 * @author Abhishek Sanoujam
 * @since 1.7
 */
public class SampledCounterConfig extends CounterConfig {

  private final int intervalSecs;
  private final int historySize;
  private final boolean isReset;

  /**
   * Make a new timed counter config (duh)
   * 
   * @param intervalSecs the interval (in seconds) between sampling
   * @param historySize number of counter samples that will be retained in memory
   * @param isResetOnSample true if the counter should be reset to 0 upon each sample
   */
  public SampledCounterConfig(int intervalSecs, int historySize, boolean isResetOnSample, long initialValue) {

    super(initialValue);
    if (intervalSecs < 1) {
      throw new IllegalArgumentException("Interval (" + intervalSecs + ") must be greater than or equal to 1");
    }
    if (historySize < 1) {
      throw new IllegalArgumentException("History size (" + historySize + ") must be greater than or equal to 1");
    }

    this.intervalSecs = intervalSecs;
    this.historySize = historySize;
    this.isReset = isResetOnSample;
  }

  /**
   * Returns the history size
   * 
   * @return The history size
   */
  public int getHistorySize() {

    return historySize;
  }

  /**
   * Returns the interval time (seconds)
   * 
   * @return Interval of the sampling thread in seconds
   */
  public int getIntervalSecs() {

    return intervalSecs;
  }

  /**
   * Returns true if counters created from this config will reset on each sample
   * 
   * @return true if values are reset to the initial value after each sample
   */
  public boolean isResetOnSample() {

    return this.isReset;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public Counter createCounter() {

    return new SampledCounterImpl(this);
  }
}