core/store/dist/src/main/java/org/onosproject/store/consistent/impl/DatabaseState.java

package org.onosproject.store.consistent.impl;

import java.util.Collection;
import java.util.List;
import java.util.Map.Entry;
import java.util.Set;

import net.kuujo.copycat.state.Command;
import net.kuujo.copycat.state.Initializer;
import net.kuujo.copycat.state.Query;
import net.kuujo.copycat.state.StateContext;

/**
 * Database state.
 *
 */
public interface DatabaseState<K, V> {

  /**
   * Initializes the database state.
   *
   * @param context The map state context.
   */
  @Initializer
  public void init(StateContext<DatabaseState<K, V>> context);

  @Query
  int size(String tableName);

  @Query
  boolean isEmpty(String tableName);

  @Query
  boolean containsKey(String tableName, K key);

  @Query
  boolean containsValue(String tableName, V value);

  @Query
  Versioned<V> get(String tableName, K key);

  @Command
  Versioned<V> put(String tableName, K key, V value);

  @Command
  Versioned<V> remove(String tableName, K key);

  @Command
  void clear(String tableName);

  @Query
  Set<K> keySet(String tableName);

  @Query
  Collection<Versioned<V>> values(String tableName);

  @Query
  Set<Entry<K, Versioned<V>>> entrySet(String tableName);

  @Command
  Versioned<V> putIfAbsent(String tableName, K key, V value);

  @Command
  boolean remove(String tableName, K key, V value);

  @Command
  boolean remove(String tableName, K key, long version);

  @Command
  boolean replace(String tableName, K key, V oldValue, V newValue);

  @Command
  boolean replace(String tableName, K key, long oldVersion, V newValue);

  @Command
  boolean batchUpdate(List<UpdateOperation<K, V>> updates);
}