Set (swaydb-java 0.7.1 API)

java.lang.Object
- swaydb.java.memory.Set<K>

Type Parameters:

K - the type of the key element

All Implemented Interfaces:

Closeable, AutoCloseable, Set<K>
```
public class Set<K>
extends Object
implements Set<K>, Closeable
```
The persistent Set of data.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Set.Builder<K>

Nested Classes
Modifier and Type	Class and Description
`static class`	`Set.Builder<K>`

Constructor Summary

Constructors
Constructor and Description

Set(swaydb.Set<K> database)
Constructs the Set object.

Constructors
Constructor and Description
`Set(swaydb.Set<K> database)` Constructs the Set object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(K key)` Adds the key to this set.
`boolean`	`add(K key, LocalDateTime expireAt)` Adds the key with expire at to this set.
`boolean`	`add(K key, long expireAfter, TimeUnit timeUnit)` Adds the key with expire after to this set.
`boolean`	`add(List<? extends K> list)` Adds the keys to this set.
`Set<K>`	`asJava()` Returns the java set of this set.
`static <K> Set.Builder<K>`	`builder()` Creates the builder.
`void`	`clear()` Clears this set.
`void`	`close()` Closes the database.
`swaydb.data.accelerate.Level0Meter`	`commit(swaydb.Prepare<K,scala.runtime.Nothing$>... prepares)` Starts the commit function for this set.
`boolean`	`contains(K key)` Checks if a set contains key.
`boolean`	`containsAll(Collection<K> collection)` Checks if a set contains key collection.
`static <K> Set<K>`	`create(Object keySerializer)` Creates the set.
`LocalDateTime`	`expiration(K key)` Returns the expiration date for key in this set.
`boolean`	`expire(K key, LocalDateTime expireAt)` Setups the expiration at for key to this set.
`boolean`	`expire(K key, long after, TimeUnit timeUnit)` Setups the expiration after for key to this set.
`boolean`	`isEmpty()` Checks if a set is empty.
`Iterator<K>`	`iterator()` Returns the iterator of elements in this set.
`swaydb.data.accelerate.Level0Meter`	`level0Meter()` Returns the level of meter for zerro level.
`Optional<swaydb.data.compaction.LevelMeter>`	`level1Meter()` Returns the level of meter for first level.
`Optional<swaydb.data.compaction.LevelMeter>`	`levelMeter(int levelNumber)` Returns the level of meter for level.
`boolean`	`mightContain(K key)` Checks if a set might contain key.
`boolean`	`nonEmpty()` Checks if a set is not empty.
`boolean`	`remove(K key)` Removes the key of this set.
`void`	`remove(K from, K to)` Removes the keys of this set.
`void`	`remove(Set<K> keys)` Removes the keys of this set.
`boolean`	`retainAll(Collection<K> collection)` Retains the keys to this set.
`int`	`size()` Returns the size of elements in this set.
`long`	`sizeOfSegments()` Returns the size for segments for this set.
`Duration`	`timeLeft(K key)` Returns the time left for key in this set.
`Object[]`	`toArray()` Returns the array of elements in this set.
`<T> T[]`	`toArray(T[] a)` Returns the typed array of elements in this set.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Set
```
public Set(swaydb.Set<K> database)
```
    Constructs the Set object.
    
    Parameters:
    
    database - the database
- Method Detail
  - contains
```
public boolean contains(K key)
```
    Checks if a set contains key.
    
    Specified by:
    
    contains in interface Set<K>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    true if a set contains key, false otherwise
  - mightContain
```
public boolean mightContain(K key)
```
    Checks if a set might contain key.
    
    Specified by:
    
    mightContain in interface Set<K>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    true if a set might contain key, false otherwise
  - iterator
```
public Iterator<K> iterator()
```
    Returns the iterator of elements in this set.
    
    Specified by:
    
    iterator in interface Set<K>
    
    Returns:
    
    the iterator of elements in this set
  - toArray
```
public Object[] toArray()
```
    Returns the array of elements in this set.
    
    Specified by:
    
    toArray in interface Set<K>
    
    Returns:
    
    the array of elements in this set
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Returns the typed array of elements in this set.
    
    Specified by:
    
    toArray in interface Set<K>
    
    Type Parameters:
    
    T - the type of the array
    
    Parameters:
    
    a - the typed object
    
    Returns:
    
    the typed array of elements in this set
  - add
```
public boolean add(K key)
```
    Adds the key to this set.
    
    Specified by:
    
    add in interface Set<K>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    true if a set contained key, false otherwise
  - add
```
public boolean add(K key,
                   long expireAfter,
                   TimeUnit timeUnit)
```
    Adds the key with expire after to this set.
    
    Specified by:
    
    add in interface Set<K>
    
    Parameters:
    
    key - the key
    
    expireAfter - the expireAfter
    
    timeUnit - the timeUnit
    
    Returns:
    
    true if a set contained key, false otherwise
  - add
```
public boolean add(K key,
                   LocalDateTime expireAt)
```
    Adds the key with expire at to this set.
    
    Specified by:
    
    add in interface Set<K>
    
    Parameters:
    
    key - the key
    
    expireAt - the expireAt
    
    Returns:
    
    true if a set contained key, false otherwise
  - expire
```
public boolean expire(K key,
                      long after,
                      TimeUnit timeUnit)
```
    Setups the expiration after for key to this set.
    
    Specified by:
    
    expire in interface Set<K>
    
    Parameters:
    
    key - the key
    
    after - the after
    
    timeUnit - the timeUnit
    
    Returns:
    
    the old value for this key or null
  - expire
```
public boolean expire(K key,
                      LocalDateTime expireAt)
```
    Setups the expiration at for key to this set.
    
    Specified by:
    
    expire in interface Set<K>
    
    Parameters:
    
    key - the key
    
    expireAt - the expireAt
    
    Returns:
    
    the old value for this key or null
  - containsAll
```
public boolean containsAll(Collection<K> collection)
```
    Checks if a set contains key collection.
    
    Specified by:
    
    containsAll in interface Set<K>
    
    Parameters:
    
    collection - the collection
    
    Returns:
    
    true if a set contains key, false otherwise
  - add
```
public boolean add(List<? extends K> list)
```
    Adds the keys to this set.
    
    Specified by:
    
    add in interface Set<K>
    
    Parameters:
    
    list - the list
    
    Returns:
    
    true if a set contained keys, false otherwise
  - retainAll
```
public boolean retainAll(Collection<K> collection)
```
    Retains the keys to this set.
    
    Specified by:
    
    retainAll in interface Set<K>
    
    Parameters:
    
    collection - the collection
    
    Returns:
    
    true if a set contained keys, false otherwise
  - remove
```
public void remove(Set<K> keys)
```
    Removes the keys of this set.
    
    Specified by:
    
    remove in interface Set<K>
    
    Parameters:
    
    keys - the keys
  - remove
```
public void remove(K from,
                   K to)
```
    Removes the keys of this set.
    
    Specified by:
    
    remove in interface Set<K>
    
    Parameters:
    
    from - the from
    
    to - the to
  - size
```
public int size()
```
    Returns the size of elements in this set.
    
    Specified by:
    
    size in interface Set<K>
    
    Returns:
    
    the size of elements in this set
  - isEmpty
```
public boolean isEmpty()
```
    Checks if a set is empty.
    
    Specified by:
    
    isEmpty in interface Set<K>
    
    Returns:
    
    true if a set is empty, false otherwise
  - nonEmpty
```
public boolean nonEmpty()
```
    Checks if a set is not empty.
    
    Specified by:
    
    nonEmpty in interface Set<K>
    
    Returns:
    
    true if a set is not empty, false otherwise
  - expiration
```
public LocalDateTime expiration(K key)
```
    Returns the expiration date for key in this set.
    
    Specified by:
    
    expiration in interface Set<K>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the expiration date for key in this set
  - timeLeft
```
public Duration timeLeft(K key)
```
    Returns the time left for key in this set.
    
    Specified by:
    
    timeLeft in interface Set<K>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the time left for key in this set
  - sizeOfSegments
```
public long sizeOfSegments()
```
    Returns the size for segments for this set.
    
    Specified by:
    
    sizeOfSegments in interface Set<K>
    
    Returns:
    
    the size for segments for this set
  - level0Meter
```
public swaydb.data.accelerate.Level0Meter level0Meter()
```
    Returns the level of meter for zerro level.
    
    Specified by:
    
    level0Meter in interface Set<K>
    
    Returns:
    
    the level of meter for zerro level
  - level1Meter
```
public Optional<swaydb.data.compaction.LevelMeter> level1Meter()
```
    Returns the level of meter for first level.
    
    Returns:
    
    the level of meter for first level
  - levelMeter
```
public Optional<swaydb.data.compaction.LevelMeter> levelMeter(int levelNumber)
```
    Returns the level of meter for level.
    
    Specified by:
    
    levelMeter in interface Set<K>
    
    Parameters:
    
    levelNumber - the level number
    
    Returns:
    
    the level of meter for first level
  - clear
```
public void clear()
```
    Clears this set.
    
    Specified by:
    
    clear in interface Set<K>
  - remove
```
public boolean remove(K key)
```
    Removes the key of this set.
    
    Specified by:
    
    remove in interface Set<K>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    true if old key was present, false otherwise
  - asJava
```
public Set<K> asJava()
```
    Returns the java set of this set.
    
    Specified by:
    
    asJava in interface Set<K>
    
    Returns:
    
    the java set of this set
  - close
```
public void close()
```
    Closes the database.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - commit
```
public swaydb.data.accelerate.Level0Meter commit(swaydb.Prepare<K,scala.runtime.Nothing$>... prepares)
```
    Starts the commit function for this set.
    
    Specified by:
    
    commit in interface Set<K>
    
    Parameters:
    
    prepares - the prepares
    
    Returns:
    
    the level zerro for this set
  - create
```
public static <K> Set<K> create(Object keySerializer)
```
    Creates the set.
    
    Type Parameters:
    
    K - the type of the key element
    
    Parameters:
    
    keySerializer - the keySerializer
    
    Returns:
    
    the set
  - builder
```
public static <K> Set.Builder<K> builder()
```
    Creates the builder.
    
    Type Parameters:
    
    K - the type of the key element
    
    Returns:
    
    the builder

Class Set<K>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Set

Method Detail

contains

mightContain

iterator

toArray

toArray

add

add

add

expire

expire

containsAll

add

retainAll

remove

remove

size

isEmpty

nonEmpty

expiration

timeLeft

sizeOfSegments

level0Meter

level1Meter

levelMeter

clear

remove

asJava

close

commit

create

builder