Map (swaydb-java 0.7.1 API)

java.lang.Object
- swaydb.java.memory.Map<K,V>

Type Parameters:

K - the type of the key element

V - the type of the value element

All Implemented Interfaces:

Closeable, AutoCloseable, Map<K,V>
```
public class Map<K,V>
extends Object
implements Map<K,V>, Closeable
```
The memory Map of data.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Map.Builder<K,V>

Nested Classes
Modifier and Type	Class and Description
`static class`	`Map.Builder<K,V>`

Constructor Summary

Constructors
Constructor and Description

Map(swaydb.Map<K,V> database)
Constructs the Map object.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyFunction(K key, K functionId)` Executes the registered function for this map.
`Map<K,V>`	`asJava()` Returns the java map of this map.
`static <K,V> Map.Builder<K,V>`	`builder()` Creates the builder.
`void`	`clear()` Clears this map.
`void`	`close()` Closes the database.
`swaydb.data.accelerate.Level0Meter`	`commit(swaydb.Prepare<K,V>... prepares)` Starts the commit function for this map.
`boolean`	`containsKey(K key)` Checks if a map contains key.
`boolean`	`containsValue(V value)` Checks if a map contains value.
`static <K,V> Map<K,V>`	`create(Object keySerializer, Object valueSerializer)` Creates the map.
`Set<Map.Entry<K,V>>`	`entrySet()` Returns the entrues for this map.
`LocalDateTime`	`expiration(K key)` Returns the expiration date for key in this map.
`V`	`expire(K key, LocalDateTime expireAt)` Setups the expiration at for key to this map.
`V`	`expire(K key, long after, TimeUnit timeUnit)` Setups the expiration after for key to this map.
`void`	`foreach(Consumer<Map.Entry<K,V>> consumer)` Starts the foreach function for this map.
`Map<K,V>`	`from(K key)` Returns the map object which starts from key for this map.
`Map<K,V>`	`fromOrAfter(K key)` Returns the map object which starts or after key for this map.
`Map<K,V>`	`fromOrBefore(K key)` Returns the map object which starts or before key for this map.
`V`	`get(K key)` Returns the value or null for key of this map.
`Map.Entry<K,V>`	`head()` Returns the head key for this map.
`Optional<Map.Entry<K,V>>`	`headOption()` Returns the optional head key for this map.
`boolean`	`isEmpty()` Checks the map is empty.
`swaydb.Set<K>`	`keys()` Returns the key objects for this map.
`Set<K>`	`keySet()` Returns the key set for this map.
`K`	`keysHead()` Returns the head key for this map.
`Optional<K>`	`keysHeadOption()` Returns the optional head key for this map.
`int`	`keySize(K key)` Returns the key size in bytes for this map.
`K`	`keysLast()` Returns the last key for this map.
`Optional<K>`	`keysLastOption()` Returns the optional last key for this map.
`Map.Entry<K,V>`	`last()` Returns the last key for this map.
`Optional<Map.Entry<K,V>>`	`lastOption()` Returns the optional last key for this map.
`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 map might contain key.
`boolean`	`nonEmpty()` Checks the map is not empty.
`V`	`put(K key, V value)` Puts the key/value pair for this map.
`V`	`put(K key, V value, LocalDateTime expireAt)` Puts the key/value pair for this map with expiration at data.
`V`	`put(K key, V value, long expireAfter, TimeUnit timeUnit)` Puts the key/value pair for this map with expiration after data.
`void`	`put(Map.Entry<K,V> entry)` Puts an entry object to this map.
`void`	`put(Map<K,V> map)` Puts a map object to this map.
`K`	`registerFunction(K functionId, Function<V,swaydb.Apply.Map<V>> function)` Registers the function for this map.
`V`	`remove(K key)` Removes the value for key of this map.
`void`	`remove(K from, K to)` Removes the values for keys of this map.
`void`	`remove(Set<K> keys)` Removes the values for key set of this map.
`int`	`size()` Returns the size of elements in this map.
`long`	`sizeOfSegments()` Returns the size for segments for this map.
`Duration`	`timeLeft(K key)` Returns the time left for key in this map.
`V`	`update(K key, V value)` Updates the key/value for this map.
`void`	`update(Map<K,V> map)` Updates map entries for this map.
`List<V>`	`values()` Returns the values for this map.
`int`	`valueSize(V value)` Returns the value size in bytes for this map.

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

- Constructor Detail
  - Map
```
public Map(swaydb.Map<K,V> database)
```
    Constructs the Map object.
    
    Parameters:
    
    database - the database
- Method Detail
  - size
```
public int size()
```
    Returns the size of elements in this map.
    
    Specified by:
    
    size in interface Map<K,V>
    
    Returns:
    
    the size of elements in this map
  - isEmpty
```
public boolean isEmpty()
```
    Checks the map is empty.
    
    Specified by:
    
    isEmpty in interface Map<K,V>
    
    Returns:
    
    true if a map is empty, false otherwise
  - nonEmpty
```
public boolean nonEmpty()
```
    Checks the map is not empty.
    
    Specified by:
    
    nonEmpty in interface Map<K,V>
    
    Returns:
    
    true if a map is not empty, false otherwise
  - expiration
```
public LocalDateTime expiration(K key)
```
    Returns the expiration date for key in this map.
    
    Specified by:
    
    expiration in interface Map<K,V>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the expiration date for key in this map
  - timeLeft
```
public Duration timeLeft(K key)
```
    Returns the time left for key in this map.
    
    Specified by:
    
    timeLeft in interface Map<K,V>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the time left for key in this map
  - keySize
```
public int keySize(K key)
```
    Returns the key size in bytes for this map.
    
    Specified by:
    
    keySize in interface Map<K,V>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the key size in bytes for this map
  - valueSize
```
public int valueSize(V value)
```
    Returns the value size in bytes for this map.
    
    Specified by:
    
    valueSize in interface Map<K,V>
    
    Parameters:
    
    value - the value
    
    Returns:
    
    the value size in bytes for this map
  - sizeOfSegments
```
public long sizeOfSegments()
```
    Returns the size for segments for this map.
    
    Specified by:
    
    sizeOfSegments in interface Map<K,V>
    
    Returns:
    
    the size for segments for this map
  - level0Meter
```
public swaydb.data.accelerate.Level0Meter level0Meter()
```
    Returns the level of meter for zerro level.
    
    Specified by:
    
    level0Meter in interface Map<K,V>
    
    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 Map<K,V>
    
    Parameters:
    
    levelNumber - the level number
    
    Returns:
    
    the level of meter for first level
  - containsKey
```
public boolean containsKey(K key)
```
    Checks if a map contains key.
    
    Specified by:
    
    containsKey in interface Map<K,V>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    true if a map contains key, false otherwise
  - mightContain
```
public boolean mightContain(K key)
```
    Checks if a map might contain key.
    
    Specified by:
    
    mightContain in interface Map<K,V>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    true if a map might contains key, false otherwise
  - head
```
public Map.Entry<K,V> head()
```
    Returns the head key for this map.
    
    Specified by:
    
    head in interface Map<K,V>
    
    Returns:
    
    the head key for this map
  - headOption
```
public Optional<Map.Entry<K,V>> headOption()
```
    Returns the optional head key for this map.
    
    Specified by:
    
    headOption in interface Map<K,V>
    
    Returns:
    
    the optional head key for this map
  - last
```
public Map.Entry<K,V> last()
```
    Returns the last key for this map.
    
    Specified by:
    
    last in interface Map<K,V>
    
    Returns:
    
    the last key for this map
  - lastOption
```
public Optional<Map.Entry<K,V>> lastOption()
```
    Returns the optional last key for this map.
    
    Specified by:
    
    lastOption in interface Map<K,V>
    
    Returns:
    
    the optional last key for this map
  - containsValue
```
public boolean containsValue(V value)
```
    Checks if a map contains value.
    
    Specified by:
    
    containsValue in interface Map<K,V>
    
    Parameters:
    
    value - the value
    
    Returns:
    
    true if a map contains value, false otherwise
  - put
```
public void put(Map<K,V> map)
```
    Puts a map object to this map.
    
    Specified by:
    
    put in interface Map<K,V>
    
    Parameters:
    
    map - the map
  - put
```
public void put(Map.Entry<K,V> entry)
```
    Puts an entry object to this map.
    
    Specified by:
    
    put in interface Map<K,V>
    
    Parameters:
    
    entry - the entry
  - update
```
public void update(Map<K,V> map)
```
    Updates map entries for this map.
    
    Specified by:
    
    update in interface Map<K,V>
    
    Parameters:
    
    map - the map
  - clear
```
public void clear()
```
    Clears this map.
    
    Specified by:
    
    clear in interface Map<K,V>
  - keySet
```
public Set<K> keySet()
```
    Returns the key set for this map.
    
    Specified by:
    
    keySet in interface Map<K,V>
    
    Returns:
    
    the key set for this map
  - keysHead
```
public K keysHead()
```
    Returns the head key for this map.
    
    Specified by:
    
    keysHead in interface Map<K,V>
    
    Returns:
    
    the head key for this map
  - keysHeadOption
```
public Optional<K> keysHeadOption()
```
    Returns the optional head key for this map.
    
    Specified by:
    
    keysHeadOption in interface Map<K,V>
    
    Returns:
    
    the optional head key for this map
  - keysLast
```
public K keysLast()
```
    Returns the last key for this map.
    
    Specified by:
    
    keysLast in interface Map<K,V>
    
    Returns:
    
    the last key for this map
  - keysLastOption
```
public Optional<K> keysLastOption()
```
    Returns the optional last key for this map.
    
    Specified by:
    
    keysLastOption in interface Map<K,V>
    
    Returns:
    
    the optional last key for this map
  - values
```
public List<V> values()
```
    Returns the values for this map.
    
    Specified by:
    
    values in interface Map<K,V>
    
    Returns:
    
    the values last key for this map
  - entrySet
```
public Set<Map.Entry<K,V>> entrySet()
```
    Returns the entrues for this map.
    
    Specified by:
    
    entrySet in interface Map<K,V>
    
    Returns:
    
    the entrues last key for this map
  - put
```
public V put(K key,
             V value)
```
    Puts the key/value pair for this map.
    
    Specified by:
    
    put in interface Map<K,V>
    
    Parameters:
    
    key - the key
    
    value - the value
    
    Returns:
    
    the old value for this key or null
  - put
```
public V put(K key,
             V value,
             long expireAfter,
             TimeUnit timeUnit)
```
    Puts the key/value pair for this map with expiration after data.
    
    Specified by:
    
    put in interface Map<K,V>
    
    Parameters:
    
    key - the key
    
    value - the value
    
    expireAfter - the expireAfter
    
    timeUnit - the timeUnit
    
    Returns:
    
    the old value for this key or null
  - put
```
public V put(K key,
             V value,
             LocalDateTime expireAt)
```
    Puts the key/value pair for this map with expiration at data.
    
    Specified by:
    
    put in interface Map<K,V>
    
    Parameters:
    
    key - the key
    
    value - the value
    
    expireAt - the expireAt
    
    Returns:
    
    the old value for this key or null
  - expire
```
public V expire(K key,
                long after,
                TimeUnit timeUnit)
```
    Setups the expiration after for key to this map.
    
    Specified by:
    
    expire in interface Map<K,V>
    
    Parameters:
    
    key - the key
    
    after - the after
    
    timeUnit - the timeUnit
    
    Returns:
    
    the old value for this key or null
  - expire
```
public V expire(K key,
                LocalDateTime expireAt)
```
    Setups the expiration at for key to this map.
    
    Specified by:
    
    expire in interface Map<K,V>
    
    Parameters:
    
    key - the key
    
    expireAt - the expireAt
    
    Returns:
    
    the old value for this key or null
  - update
```
public V update(K key,
                V value)
```
    Updates the key/value for this map.
    
    Specified by:
    
    update in interface Map<K,V>
    
    Parameters:
    
    key - the key
    
    value - the value
    
    Returns:
    
    the old value for this key or null
  - get
```
public V get(K key)
```
    Returns the value or null for key of this map.
    
    Specified by:
    
    get in interface Map<K,V>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the value or null for key of this map
  - remove
```
public V remove(K key)
```
    Removes the value for key of this map.
    
    Specified by:
    
    remove in interface Map<K,V>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the old value or null for key of this map
  - remove
```
public void remove(Set<K> keys)
```
    Removes the values for key set of this map.
    
    Specified by:
    
    remove in interface Map<K,V>
    
    Parameters:
    
    keys - the keys
  - remove
```
public void remove(K from,
                   K to)
```
    Removes the values for keys of this map.
    
    Specified by:
    
    remove in interface Map<K,V>
    
    Parameters:
    
    from - the from
    
    to - the to
  - asJava
```
public Map<K,V> asJava()
```
    Returns the java map of this map.
    
    Specified by:
    
    asJava in interface Map<K,V>
    
    Returns:
    
    the java map of this map
  - registerFunction
```
public K registerFunction(K functionId,
                          Function<V,swaydb.Apply.Map<V>> function)
```
    Registers the function for this map.
    
    Specified by:
    
    registerFunction in interface Map<K,V>
    
    Parameters:
    
    functionId - the functionId
    
    function - the function
    
    Returns:
    
    the function id
  - applyFunction
```
public void applyFunction(K key,
                          K functionId)
```
    Executes the registered function for this map.
    
    Specified by:
    
    applyFunction in interface Map<K,V>
    
    Parameters:
    
    key - the key
    
    functionId - the functionId
  - from
```
public Map<K,V> from(K key)
```
    Returns the map object which starts from key for this map.
    
    Specified by:
    
    from in interface Map<K,V>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the map object
  - fromOrAfter
```
public Map<K,V> fromOrAfter(K key)
```
    Returns the map object which starts or after key for this map.
    
    Specified by:
    
    fromOrAfter in interface Map<K,V>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the map object
  - fromOrBefore
```
public Map<K,V> fromOrBefore(K key)
```
    Returns the map object which starts or before key for this map.
    
    Specified by:
    
    fromOrBefore in interface Map<K,V>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the map object
  - keys
```
public swaydb.Set<K> keys()
```
    Returns the key objects for this map.
    
    Specified by:
    
    keys in interface Map<K,V>
    
    Returns:
    
    the key objects for this map
  - foreach
```
public void foreach(Consumer<Map.Entry<K,V>> consumer)
```
    Starts the foreach function for this map.
    
    Specified by:
    
    foreach in interface Map<K,V>
    
    Parameters:
    
    consumer - the consumer
  - 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,V>... prepares)
```
    Starts the commit function for this map.
    
    Specified by:
    
    commit in interface Map<K,V>
    
    Parameters:
    
    prepares - the prepares
    
    Returns:
    
    the level zerro for this map
  - create
```
public static <K,V> Map<K,V> create(Object keySerializer,
                                    Object valueSerializer)
```
    Creates the map.
    
    Type Parameters:
    
    K - the type of the key element
    
    V - the type of the value element
    
    Parameters:
    
    keySerializer - the keySerializer
    
    valueSerializer - the valueSerializer
    
    Returns:
    
    the map
  - builder
```
public static <K,V> Map.Builder<K,V> builder()
```
    Creates the builder.
    
    Type Parameters:
    
    K - the type of the key element
    
    V - the type of the value element
    
    Returns:
    
    the builder

Class Map<K,V>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Map

Method Detail

size

isEmpty

nonEmpty

expiration

timeLeft

keySize

valueSize

sizeOfSegments

level0Meter

level1Meter

levelMeter

containsKey

mightContain

head

headOption

last

lastOption

containsValue

put

put

update

clear

keySet

keysHead

keysHeadOption

keysLast

keysLastOption

values

entrySet

put

put

put

expire

expire

update

get

remove

remove

remove

asJava

registerFunction

applyFunction

from

fromOrAfter

fromOrBefore

keys

foreach

close

commit

create

builder