com.gemstone.gemfire.cache.InterestResultPolicy 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;

import com.gemstone.gemfire.internal.cache.tier.sockets.InterestResultPolicyImpl;
import java.io.ObjectStreamException;
import java.io.Serializable;

/**
 * Class InterestResultPolicy is an enumerated type for a
 * register interest result. The result of a call to Region.registerInterest
 * can be the keys and current values, just the keys or nothing.
 *
 * @author Barry Oglesby
 *
 * @see com.gemstone.gemfire.cache.Region#registerInterest(Object)
 * @see com.gemstone.gemfire.cache.Region#registerInterestRegex(String)
 *
 * @since 4.2.3
 */
public class InterestResultPolicy implements Serializable {
  private static final long serialVersionUID = -4993765891973030160L;

  private static byte nextOrdinal = 0;

  private static final InterestResultPolicy[] VALUES = new InterestResultPolicy[3];

  public static final InterestResultPolicy NONE = new InterestResultPolicyImpl("NONE");
  public static final InterestResultPolicy KEYS = new InterestResultPolicyImpl("KEYS");
  public static final InterestResultPolicy KEYS_VALUES = new InterestResultPolicyImpl("KEYS_VALUES");

  /**
   * The InterestResultPolicy used by default; it is {@link #KEYS_VALUES}.
   */
  public static final InterestResultPolicy DEFAULT = KEYS_VALUES;


  /** The name of this InterestResultPolicy. */
  private final transient String name;

  /** The ordinal representing this InterestResultPolicy. */
  public final byte ordinal;

  protected Object readResolve() throws ObjectStreamException {
    return VALUES[ordinal];  // Canonicalize
  }


  /** should only be called from InterestResultPolicyImpl */
  protected InterestResultPolicy(String name) {
    this.name = name;
    this.ordinal = nextOrdinal++;
    VALUES[this.ordinal] = this;
  }

  /** Returns the InterestResultPolicy represented by specified ordinal */
  public static InterestResultPolicy fromOrdinal(byte ordinal) {
    return VALUES[ordinal];
  }
  /** Returns the ordinal value.
   * @since 5.0
   */
  public byte getOrdinal() {
    return this.ordinal;
  }

  /**
   * Returns true if this InterestResultPolicy is {@link #NONE}.
   * @return true if this InterestResultPolicy is {@link #NONE}.
   */
  public boolean isNone() {
    return this == NONE;
  }

  /**
   * Returns true if this InterestResultPolicy is {@link #KEYS}.
   * @return true if this InterestResultPolicy is {@link #KEYS}.
   */
  public boolean isKeys() {
    return this == KEYS;
  }

  /**
   * Returns true if this InterestResultPolicy is {@link #KEYS_VALUES}.
   * @return true if this InterestResultPolicy is {@link #KEYS_VALUES}.
   */
  public boolean isKeysValues() {
    return this == KEYS_VALUES;
  }

  /**
   * Returns true if this InterestResultPolicy is the default.
   * @return true if this InterestResultPolicy is the default.
   */
  public boolean isDefault() {
    return this == DEFAULT;
  }

  /** Returns a string representation for this InterestResultPolicy.
   * @return the name of this data policy.
   */
  @Override // GemStoneAddition
  public String toString() {
    return this.name;
  }
}