com.gemstone.gemfire.cache.Scope 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
The newest version!
/*
 * 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.i18n.LocalizedStrings;

import java.io.*;

/**
 * Enumerated type for region distribution scope.
 *
 * @author Eric Zoerner
 *
 *
 * @see RegionAttributes#getScope
 * @see AttributesFactory#setScope
 * @since 3.0
 */
public class Scope implements Serializable {
    private static final long serialVersionUID = 5534399159504301602L;
  
    /** The region with this attribute is scoped to this JVM only. Operations and data
     * are not distributed to other caches.
     */
    public static final Scope LOCAL = new Scope("LOCAL");
    
    /** The region or cached object with this attribute is scoped
     * to the distributed cached system; any distributed
     * operation will return without waiting for the remote acknowledgment.
     */
    public static final Scope DISTRIBUTED_NO_ACK = new Scope("DISTRIBUTED_NO_ACK");
    
    /**
     * The region or cached object with this attribute is scoped
     * to the distributed cached system; any distributed
     * operation will not return until all the remote acknowledgments
     * come back.
     */
    public static final Scope DISTRIBUTED_ACK = new Scope("DISTRIBUTED_ACK");
    
    /**
     * The region or cached object with this attribute is scoped
     * to the distributed cached system; locking is used 
     * for all distributed operations on entries
     * to guarantee consistency across the distributed caches.
     */
    public static final Scope GLOBAL = new Scope("GLOBAL");

    /** The name of this scope.*/
    private final transient String name;
    
    // The 4 declarations below are necessary for serialization
    /** int used as ordinal to represent this Scope */
    public final int ordinal = nextOrdinal++;
 
    private static int nextOrdinal = 0;
    
    private static final Scope[] VALUES =
      { LOCAL, DISTRIBUTED_NO_ACK, DISTRIBUTED_ACK, GLOBAL };
      
    /* The following 4 definitions are included for use by the C 
     * interface. Any changes to the order of the scopes in VALUES
     * must be reflected here and changed in gemfire.h.
     */
    final static int SCOPE_LOCAL = 0;
    final static int SCOPE_DISTRIBUTED_NO_ACK= 1;
    final static int SCOPE_DISTRIBUTED_ACK = 2;
    final static int SCOPE_GLOBAL = 3;

    private Object readResolve() throws ObjectStreamException {
      return fromOrdinal(ordinal);  // Canonicalize
    }
   
    
    /** Creates a new instance of Scope. */
    private Scope(String name) {
        this.name = name;
    }
    
    /** Return the Scope represented by specified ordinal */
    public static Scope fromOrdinal(int ordinal) {
      return VALUES[ordinal];
    }
    
    /** Returns whether this is local scope.
     * @return true if this is LOCAL
     */    
    public boolean isLocal() {
      return this == LOCAL;
    }
    
    /** Returns whether this is one of the distributed scopes.
     * @return true if this is any scope other than LOCAL
     */    
    public boolean isDistributed() {
      return this != LOCAL;
    }
    
    /** Returns whether this is distributed no ack scope.
     * @return true if this is DISTRIBUTED_NO_ACK
     */    
    public boolean isDistributedNoAck() {
      return this == DISTRIBUTED_NO_ACK;
    }
    
    /** Returns whether this is distributed ack scope.
     * @return true if this is DISTRIBUTED_ACK
     */    
    public boolean isDistributedAck() {
      return this == DISTRIBUTED_ACK;
    }
    
    /** Returns whether this is global scope.
     * @return true if this is GLOBAL
     */    
    public boolean isGlobal() {
      return this == GLOBAL;
    }
    
    /** Returns whether acknowledgements are required for this scope.
     * @return true if this is DISTRIBUTED_ACK or GLOBAL, false otherwise
     */    
    public boolean isAck() {
      return this == DISTRIBUTED_ACK || this == GLOBAL;
    }
    
    
    /** Returns a string representation for this scope.
     * @return String the name of this scope
     */
    @Override
    public String toString() {
        return this.name;
    }

    /**
     * Parse the given string into a Scope 
     * @param scope the provided String form of Scope
     * @return the canonical Scope associated with the string
     */
    public static Scope fromString(String scope) {
      for (int i=0; i