com.gemstone.gemfire.cache.ExpirationAction 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 java.io.*;

/**
 * Enumerated type for expiration actions.
 *
 * @author Eric Zoerner
 *
 *
 * @see ExpirationAttributes
 * @since 3.0
 */
public class ExpirationAction implements Serializable {
    private static final long serialVersionUID = 658925707882047900L;
    
    /** When the region or cached object expires, it is invalidated. */
    public final static ExpirationAction INVALIDATE = new ExpirationAction("INVALIDATE");
    /** When expired, invalidated locally only. Not supported for partitioned regions. */
    public final static ExpirationAction LOCAL_INVALIDATE = new ExpirationAction("LOCAL_INVALIDATE");
    
    /** When the region or cached object expires, it is destroyed. */
    public final static ExpirationAction DESTROY = new ExpirationAction("DESTROY");
    /** When expired, destroyed locally only. Not supported for partitioned regions. Use DESTROY instead. */
    public final static ExpirationAction LOCAL_DESTROY = new ExpirationAction("LOCAL_DESTROY");
    
    /** The name of this action */
    private final transient String name;
    
    /** Creates a new instance of ExpirationAction.
     * 
     * @param name the name of the expiration action
     * @see #toString
     */
    private ExpirationAction(String name) {
        this.name = name;
    }
    
    /**
     * Returns whether this is the action for distributed invalidate.
     * @return true if this in INVALIDATE
     */
    public boolean isInvalidate() {
      return this == INVALIDATE;
    }
    
    /**
     * Returns whether this is the action for local invalidate.
     * @return true if this is LOCAL_INVALIDATE
     */
    public boolean isLocalInvalidate() {
      return this == LOCAL_INVALIDATE;
    }
    
    /** Returns whether this is the action for distributed destroy.
     * @return true if this is DESTROY
     */
    public boolean isDestroy() {
      return this == DESTROY;
    }
    
    /** Returns whether this is the action for local destroy.
     * @return true if thisis LOCAL_DESTROY
     */
    public boolean isLocalDestroy() {
      return this == LOCAL_DESTROY;
    }
    
    /** Returns whether this action is local.
     * @return true if this is LOCAL_INVALIDATE or LOCAL_DESTROY
     */
    public boolean isLocal() {
      return this == LOCAL_INVALIDATE || this == LOCAL_DESTROY;
    }
    
    /** Returns whether this action is distributed.
     * @return true if this is INVALIDATE or DESTROY
     */
    public boolean isDistributed() {
      return !isLocal();
    }    
        
    /** Returns a string representation for this action
     * @return the name of this action
     */
    @Override
    public String toString() {
        return this.name;
    }

    // The 4 declarations below are necessary for serialization
    private static int nextOrdinal = 0;
    public final int ordinal = nextOrdinal++;
    private static final ExpirationAction[] VALUES =
      { INVALIDATE, LOCAL_INVALIDATE, DESTROY, LOCAL_DESTROY};
    private Object readResolve() throws ObjectStreamException {
      return fromOrdinal(ordinal);  // Canonicalize
    }

    /** Return the ExpirationAction represented by specified ordinal */
    public static ExpirationAction fromOrdinal(int ordinal) {
      return VALUES[ordinal];
    }

}