com.alachisoft.ncache.client.datastructures.Counter Maven / Gradle / Ivy

Go to download
package com.alachisoft.ncache.client.datastructures;

//  Copyright (c) 2020 Alachisoft
//
//  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

/**
 * This interface contains methods and parameters for Distributed Counter.
 */
public interface Counter extends java.lang.Comparable, DistributedDataStructure, Notifiable {

    long _value = 0;


    /**
     * Sets the given value of the counter.
     * @param value value to be assigned to the counter.
     * @return Current value of the counter.
     */
    long setValue(long value) ;

    /**
     * Gets the value of counter.
     * @return Current value of the counter.
     */
    long getValue();


    /**
     * Increment the value of distributed counter by one.
     * @return Current value of the counter.
     */
    long increment();


    /**
     * Decrement the value of distributed counter by one.
     * @return Current value of the counter.
     */
    long decrement();


    /**
     * Increment the value of distributed counter by the amount specified.
     * @param value The value to increment by.
     * @return Current value of the counter.
     */
    long incrementBy(long value);


    /**
     * Decrement the value of distributed counter by the amount specified.
     * @param value The value to decrement by.
     * @return Current value of the counter.
     */
    long decrementBy(long value);
}