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

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;

import com.gemstone.gemfire.cache.InterestResultPolicy;

/**
 * Encapsulates a {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#REGISTER_INTEREST} region operation for
 * the pre-operation case.
 * 
 * @author Sumedh Wale
 * @since 5.5
 */
public class RegisterInterestOperationContext extends InterestOperationContext {

  /** The InterestResultPolicy for this list of keys. */
  private InterestResultPolicy policy;

  /**
   * Constructor for the register interest operation.
   * 
   * @param key
   *                the key or list of keys being registered
   * @param interestType
   *                the InterestType of the register request
   * @param policy
   *                the InterestResultPolicy of the register
   *                request
   */
  public RegisterInterestOperationContext(Object key,
      InterestType interestType, InterestResultPolicy policy) {
    super(key, interestType);
    this.policy = policy;
  }

  /**
   * Return the operation associated with the OperationContext
   * object.
   * 
   * @return OperationCode.REGISTER_INTEREST.
   */
  @Override
  public OperationCode getOperationCode() {
    return OperationCode.REGISTER_INTEREST;
  }

  /**
   * Get the InterestResultPolicy of this register/unregister
   * operation.
   * 
   * @return the InterestResultPolicy of this request.
   */
  public InterestResultPolicy getInterestResultPolicy() {
    return this.policy;
  }

}