com.gemstone.gemfire.cache.operations.KeyOperationContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation
SnappyData store based off Pivotal GemFireXD
There is a newer version: 2.0-BETA
/*
 * 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.cache.operations;


/**
 * Encapsulates a region operation that requires only a key object for the
 * pre-operation case. The operations this class encapsulates are
 * {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#DESTROY} 
 * and {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#CONTAINS_KEY}.
 * 
 * @author Sumedh Wale
 * @since 5.5
 */
public abstract class KeyOperationContext extends OperationContext {

  /** The key object of the operation */
  private Object key;

  /** Callback object for the operation (if any) */
  private Object callbackArg;

  /** True if this is a post-operation context */
  private boolean postOperation;

  /**
   * Constructor for the operation.
   * 
   * @param key
   *                the key for this operation
   */
  public KeyOperationContext(Object key) {
    this.key = key;
    this.callbackArg = null;
    this.postOperation = false;
  }

  /**
   * Constructor for the operation.
   * 
   * @param key
   *                the key for this operation
   * @param postOperation
   *                true to set the post-operation flag
   */
  public KeyOperationContext(Object key, boolean postOperation) {
    this.key = key;
    this.callbackArg = null;
    this.postOperation = postOperation;
  }

  /**
   * Return the operation associated with the OperationContext
   * object.
   * 
   * @return The OperationCode of this operation. This is one of
   *         {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#DESTROY} 
   *         or {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#CONTAINS_KEY}
   *         for KeyOperationContext, and one of
   *         {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#GET} or 
   *         {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#PUT} for
   *         KeyValueOperationContext.
   */
  @Override
  public abstract OperationCode getOperationCode();

  /**
   * True if the context is for post-operation.
   */
  @Override
  public boolean isPostOperation() {
    return this.postOperation;
  }

  /**
   * Set the post-operation flag to true.
   */
  protected void setPostOperation() {
    this.postOperation = true;
  }

  /**
   * Get the key object for this operation.
   * 
   * @return the key object for this operation.
   */
  public Object getKey() {
    return this.key;
  }

  /**
   * Get the callback argument object for this operation.
   * 
   * @return the callback argument object for this operation.
   */
  public Object getCallbackArg() {
    return this.callbackArg;
  }

  /**
   * Set the callback argument object for this operation.
   * 
   * @param callbackArg
   *                the callback argument object for this operation.
   */
  public void setCallbackArg(Object callbackArg) {
    this.callbackArg = callbackArg;
  }

}