org.ehcache.management.providers.statistics.StandardOperationStatistic Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ehcache-management Show documentation
The Management and Monitoring module of Ehcache 3
There is a newer version: 3.10.8
/*
 * Copyright 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.ehcache.management.providers.statistics;

import org.ehcache.core.statistics.CacheOperationOutcomes;
import org.terracotta.context.extended.OperationType;
import org.terracotta.context.query.Query;

import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

import static org.terracotta.context.query.Queries.self;


/**
 * The Enum OperationType.
 */
enum StandardOperationStatistic implements OperationType {
  CACHE_LOADING(false, self(), CacheOperationOutcomes.CacheLoadingOutcome.class, "cacheLoading", "cache"),

  /**
   * The cache get.
   */
  CACHE_GET(true, self(), CacheOperationOutcomes.GetOutcome.class, "get", "cache"),

  /**
   * The cache put.
   */
  CACHE_PUT(true, self(), CacheOperationOutcomes.PutOutcome.class, "put", "cache"),

  /**
   * The cache remove.
   */
  CACHE_REMOVE(true, self(), CacheOperationOutcomes.RemoveOutcome.class, "remove", "cache"),

  /**
   * The cache remove(K, V)
   */
  CACHE_CONDITIONAL_REMOVE(true, self(), CacheOperationOutcomes.ConditionalRemoveOutcome.class, "conditionalRemove", "cache"),

  /**
   * The cache putIfAbsent.
   */
  CACHE_PUT_IF_ABSENT(true, self(), CacheOperationOutcomes.PutIfAbsentOutcome.class, "putIfAbsent", "cache"),

  /**
   * The cache replace.
   */
  CACHE_REPLACE(true, self(), CacheOperationOutcomes.ReplaceOutcome.class, "replace", "cache"),

  ;

  private final boolean required;
  private final Query context;
  private final Class> type;
  private final String name;
  private final Set tags;

  StandardOperationStatistic(boolean required, Query context, Class> type, String name, String... tags) {
    this.required = required;
    this.context = context;
    this.type = type;
    this.name = name;
    this.tags = Collections.unmodifiableSet(new HashSet(Arrays.asList(tags)));
  }

  /**
   * If this statistic is required.
   * 
   * If required and this statistic is not present an exception will be thrown.
   *
   * @return
   */
  public final boolean required() {
    return required;
  }

  /**
   * Query that select context nodes for this statistic.
   *
   * @return context query
   */
  public final Query context() {
    return context;
  }

  /**
   * Operation result type.
   *
   * @return operation result type
   */
  @SuppressWarnings("rawtypes")
  public final Class> type() {
    return type;
  }

  /**
   * The name of the statistic as found in the statistics context tree.
   *
   * @return the statistic name
   */
  public final String operationName() {
    return name;
  }

  /**
   * A set of tags that will be on the statistic found in the statistics context tree.
   *
   * @return the statistic tags
   */
  public final Set tags() {
    return tags;
  }

}