Map (swaydb-java 0.7.1 API)

Type Parameters:

K - the type of the key element

V - the type of the value element

All Known Implementing Classes:

Map, Map, Map
```
public interface Map<K,V>
```
The Map of data.

Method Summary

All Methods Instance Methods Abstract 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.
`void`	`clear()` Clears this map.
`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.
`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>`	`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.

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

Interface Map<K,V>

Method Summary

Method Detail

size

isEmpty

nonEmpty

expiration

timeLeft

keySize

valueSize

sizeOfSegments

level0Meter

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

commit