/*
 * 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.core.statistics;

CacheOperationOutcomes
/**
 * CacheOperationOutcomes
 */
public interface CacheOperationOutcomes {

  
Outcomes for cache Clear operations.
/**
   * Outcomes for cache Clear operations.
   */
  enum ClearOutcome implements CacheOperationOutcomes {
    
success
/**
     * success
     */
    SUCCESS,
    
failure
/**
     * failure
     */
    FAILURE
  }

  
Outcomes for cache Get operations.
/**
   * Outcomes for cache Get operations.
   */
  enum GetOutcome implements CacheOperationOutcomes {
    
hit, loader or not is Cache impl specific /** hit, loader or not is Cache impl specific */
    HIT,
    
miss, loader or not is Cache impl specific/** miss, loader or not is Cache impl specific*/
    MISS,
    
failure /** failure */
    FAILURE
  }

  
Outcomes for cache getAll operation
/**
   * Outcomes for cache getAll operation
   */
  enum GetAllOutcome implements  CacheOperationOutcomes {
    
success, can be partial
/**
     * success, can be partial
     */
    SUCCESS,
    
failure
/**
     * failure
     */
    FAILURE
  }

  
The outcomes for Put Outcomes.
/**
   * The outcomes for Put Outcomes.
   */
  enum PutOutcome implements CacheOperationOutcomes {
    
put. /** put. */
    PUT,
    
updated. /** updated. */
    NOOP,
    
failure /** failure */
    FAILURE
  }

  
Outcomes for cache putAll operation
/**
   * Outcomes for cache putAll operation
   */
  enum PutAllOutcome implements CacheOperationOutcomes {
    
success
/**
     * success
     */
    SUCCESS,
    
failure
/**
     * failure
     */
    FAILURE
  }

  
The outcomes for remove operations.
/**
   * The outcomes for remove operations.
   */
  enum RemoveOutcome implements CacheOperationOutcomes {
    
success. /** success. */
    SUCCESS,
    
no op. /** no op. */
    NOOP,
    
failure /** failure */
    FAILURE
  }

  
Outcomes for cache removeAll operation
/**
   * Outcomes for cache removeAll operation
   */
  enum RemoveAllOutcome implements CacheOperationOutcomes {
    
success
/**
     * success
     */
    SUCCESS,
    
failure
/**
     * failure
     */
    FAILURE
  }

  
The outcomes for conditional remove operations.
/**
   * The outcomes for conditional remove operations.
   */
  enum ConditionalRemoveOutcome implements CacheOperationOutcomes {
    
Remove success
/**
     * Remove success
     */
    SUCCESS,
    
Remove failed, a mapping was present
/**
     * Remove failed, a mapping was present
     */
    FAILURE_KEY_PRESENT,
    
Remove failed, a mapping was not present
/**
     * Remove failed, a mapping was not present
     */
    FAILURE_KEY_MISSING,
    
Operation failure
/**
     * Operation failure
     */
    FAILURE
  }

  
The putIfAbsent outcomes.
/**
   * The putIfAbsent outcomes.
   */
  enum PutIfAbsentOutcome implements CacheOperationOutcomes {
    
operation installed a mapping
/**
     * operation installed a mapping
     */
    PUT,
    
there was a mapping present
/**
     * there was a mapping present
     */
    HIT,
    
operation failure
/**
     * operation failure
     */
    FAILURE
  }

  
The replace outcomes.
/**
   * The replace outcomes.
   */
  enum ReplaceOutcome implements CacheOperationOutcomes {
    
replaced mapping
/**
     * replaced mapping
     */
    HIT,
    
mapping present and not replaced
/**
     * mapping present and not replaced
     */
    MISS_PRESENT,
    
no mapping present
/**
     * no mapping present
     */
    MISS_NOT_PRESENT,
    
operation failure
/**
     * operation failure
     */
    FAILURE
  }
}