org.gridgain.grid.cache.datastructures.GridCacheAtomicLong Maven / Gradle / Ivy

Go to download
/* 
 Copyright (C) GridGain Systems. 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.
 */

/*  _________        _____ __________________        _____
 *  __  ____/___________(_)______  /__  ____/______ ____(_)_______
 *  _  / __  __  ___/__  / _  __  / _  / __  _  __ `/__  / __  __ \
 *  / /_/ /  _  /    _  /  / /_/ /  / /_/ /  / /_/ / _  /  _  / / /
 *  \____/   /_/     /_/   \_,__/   \____/   \__,_/  /_/   /_/ /_/
 */

package org.gridgain.grid.cache.datastructures;

import org.gridgain.grid.*;

/**
 * This interface provides a rich API for working with distributedly cached atomic long value.
 * 
 * 
Functionality
 * Distributed atomic long includes the following main functionality:
 * 
 * 
 * Method {@link #get()} synchronously gets current value of atomic long.
 * 
 * 
 * Various {@code get..(..)} methods synchronously get current value of atomic long
 * and increase or decrease value of atomic long.
 * 
 * 
 * Method {@link #addAndGet(long l)} synchronously sums {@code l} with current value of atomic long
 * and returns result.
 * 
 * 
 * Method {@link #incrementAndGet()} synchronously increases value of atomic long and returns result.
 * 
 * 
 * Method {@link #decrementAndGet()} synchronously decreases value of atomic long and returns result.
 * 
 * 
 * Method {@link #getAndSet(long l)} synchronously gets current value of atomic long and sets {@code l}
 * as value of atomic long.
 * 
 * 
 * All previously described methods have asynchronous analogs.
 * 
 * 
 * Method {@link #name()} gets name of atomic long.
 * 
 * 
 * 
 * 
Creating Distributed Atomic Long
 * Instance of distributed atomic long can be created by calling the following method:
 * 
 *     {@link GridCacheDataStructures#atomicLong(String, long, boolean)}
 * 
 * @see GridCacheDataStructures#atomicLong(String, long, boolean)
 * @see GridCacheDataStructures#removeAtomicLong(String)
 */
public interface GridCacheAtomicLong {
    /**
     * Name of atomic long.
     *
     * @return Name of atomic long.
     */
    public String name();

    /**
     * Gets current value of atomic long.
     *
     * @return Current value of atomic long.
     * @throws GridException If operation failed.
     */
    public long get() throws GridException;

    /**
     * Increments and gets current value of atomic long.
     *
     * @return Value.
     * @throws GridException If operation failed.
     */
    public long incrementAndGet() throws GridException;

    /**
     * Gets and increments current value of atomic long.
     *
     * @return Value.
     * @throws GridException If operation failed.
     */
    public long getAndIncrement() throws GridException;

    /**
     * Adds {@code l} and gets current value of atomic long.
     *
     * @param l Number which will be added.
     * @return Value.
     * @throws GridException If operation failed.
     */
    public long addAndGet(long l) throws GridException;

    /**
     * Gets current value of atomic long and adds {@code l}.
     *
     * @param l Number which will be added.
     * @return Value.
     * @throws GridException If operation failed.
     */
    public long getAndAdd(long l) throws GridException;

    /**
     * Decrements and gets current value of atomic long.
     *
     * @return Value.
     * @throws GridException If operation failed.
     */
    public long decrementAndGet() throws GridException;

    /**
     * Gets and decrements current value of atomic long.
     *
     * @return Value.
     * @throws GridException If operation failed.
     */
    public long getAndDecrement() throws GridException;

    /**
     * Gets current value of atomic long and sets new value {@code l} of atomic long.
     *
     * @param l New value of atomic long.
     * @return Value.
     * @throws GridException If operation failed.
     */
    public long getAndSet(long l) throws GridException;

    /**
     * Atomically compares current value to the expected value, and if they are equal, sets current value
     * to new value.
     *
     * @param expVal Expected atomic long's value.
     * @param newVal New atomic long's value to set if current value equal to expected value.
     * @return {@code True} if comparison succeeded, {@code false} otherwise.
     * @throws GridException If failed.
     */
    public boolean compareAndSet(long expVal, long newVal) throws GridException;

    /**
     * Gets status of atomic.
     *
     * @return {@code true} if atomic was removed from cache, {@code false} in other case.
     */
    public boolean removed();
}