com.distkv.core.concepts.DistkvSets Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of distkv-core Show documentation

The newest version!

package com.distkv.core.concepts;

import com.distkv.common.exception.KeyNotFoundException;
import com.distkv.common.utils.Status;
import java.util.Set;

public interface DistkvSets {

  /**
   * This method will put a key-value pair to map
   *
   * @param key   the key to store
   * @param value the set value to store
   */
  void put(String key, Set value);

  /**
   * This method will query a set value based on the key
   *
   * @param key Obtain a set value based on the key
   * @return the set value
   */
  Set get(String key);

  /**
   * Put item to the set.
   *
   * @param key The key that represents the name of the set.
   * @param itemValue The value of the item which will be putted into the set.
   */
  void putItem(String key, String itemValue);

  /**
   * This method will delete the whole set based on the key
   *
   * @param key delete the whole set based on the key
   * @return Status indicates that the deletion succeeded or failed.
   */
  Status drop(String key);

  /**
   * This method will delete a value according to the key.
   *
   * @param key The key existing in set.
   * @param itemValue The item value will be deleted.
   * @return Status Indicates that the deletion succeeded or failed.
   * */
  Status removeItem(String key, String itemValue);

  /**
   * This method will judge that if the value exists in map or not.
   *
   * @param key   the key exists in map
   * @param value the set value you want to judge
   * @return Status indicates that the value exists or not.
   * @throws KeyNotFoundException If the key don't exist in map
   */
  boolean exists(String key, String value) throws KeyNotFoundException;

}