org.jnosql.diana.redis.key.Counter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of redis-driver

The Eclipse JNoSQL communication layer, Diana, implementation Redis

There is a newer version: 0.0.9

/*
 *  Copyright (c) 2017 Otávio Santana and others
 *   All rights reserved. This program and the accompanying materials
 *   are made available under the terms of the Eclipse Public License v1.0
 *   and Apache License v2.0 which accompanies this distribution.
 *   The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 *   and the Apache License v2.0 is available at http://www.opensource.org/licenses/apache2.0.php.
 *
 *   You may elect to redistribute this code under either of these licenses.
 *
 *   Contributors:
 *
 *   Otavio Santana
 */
package org.jnosql.diana.redis.key;


import java.time.Duration;

/**
 * The redis counter structure
 */
public interface Counter {

    /**
     * @return The counter value
     */
    Number get();

    /**
     * Increments by one the counter
     *
     * @return the increment by one result
     */
    Number increment();

    /**
     * Increments the counter
     *
     * @param value the value to be increased
     * @return the increment result
     * @throws NullPointerException when value is null
     */
    Number increment(Number value) throws NullPointerException;

    /**
     * Decrements by one the counter
     *
     * @return the increment by one result
     */
    Number decrement();

    /**
     * Decrements
     *
     * @param value the value to be decreased
     * @return the decrement result
     */
    Number decrement(Number value);

    /**
     * Delete this Counter
     */
    void delete();


    /**
     * Defines a ttl to SortedSet
     *
     * @param ttl the ttl
     * @throws NullPointerException when either key and ttl are null
     */
    void expire(Duration ttl) throws NullPointerException;

    /**
     * Removes the ttl
     */
    void persist();
}