swaydb.java.SetMapT.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java_2.12 Show documentation
java
There is a newer version: 0.16.2
/*
 * Copyright (c) 2020 Simer JS Plaha ([email protected] - @simerplaha)
 *
 * This file is a part of SwayDB.
 *
 * SwayDB is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * SwayDB is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with SwayDB. If not, see .
 *
 * Additional permission under the GNU Affero GPL version 3 section 7:
 * If you modify this Program or any covered work, only by linking or combining
 * it with separate works, the licensors of this Program grant you additional
 * permission to convey the resulting work.
 */

package swaydb.java

import java.nio.file.Path
import java.time.Duration
import java.util.Optional

import swaydb.data.accelerate.LevelZeroMeter
import swaydb.data.compaction.LevelMeter
import swaydb.{Expiration, KeyVal}

/**
 * Base trait for a basic SwayDB SetMap type.
 */
trait SetMapT[K, V] extends swaydb.java.Source[K, KeyVal[K, V]] {

  def path: Path

  def put(key: K, value: V): Unit

  def put(key: K, value: V, expireAfter: Duration): Unit

  def put(keyValues: Stream[KeyVal[K, V]]): Unit

  def put(keyValues: java.lang.Iterable[KeyVal[K, V]]): Unit

  def put(keyValues: java.util.Iterator[KeyVal[K, V]]): Unit

  def remove(key: K): Unit

  def remove(keys: Stream[K]): Unit

  def remove(keys: java.lang.Iterable[K]): Unit

  def remove(keys: java.util.Iterator[K]): Unit

  def expire(key: K, after: Duration): Unit

  def clearKeyValues(): Unit

  def get(key: K): Optional[V]

  def getKey(key: K): Optional[K]

  def getKeyValue(key: K): Optional[KeyVal[K, V]]

  def contains(key: K): Boolean

  def mightContain(key: K): Boolean

  def levelZeroMeter: LevelZeroMeter

  def levelMeter(levelNumber: Int): Optional[LevelMeter]

  def sizeOfSegments: Long

  def expiration(key: K): Optional[Expiration]

  def timeLeft(key: K): Optional[Duration]

  def head: Optional[KeyVal[K, V]]

  def keys: Stream[K]

  def values: Stream[V]

  def sizeOfBloomFilterEntries: Int

  def isEmpty: Boolean

  def nonEmpty: Boolean

  def last: Optional[KeyVal[K, V]]

  def asJava: java.util.Map[K, V]

  def close(): Unit

  def delete(): Unit
}