Package com.ptsmods.mysqlw.collection

Class DbMap<K,V>

java.lang.Object

java.util.AbstractMap<K,V>

com.ptsmods.mysqlw.collection.DbMap<K,V>

All Implemented Interfaces:

DbCollection, Map<K,V>

public class DbMap<K,V>
extends AbstractMap<K,V>
implements DbCollection

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DbMap.DbMapEntry<K,V>

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Method Summary

Modifier and Type	Method	Description
void	clear()
CompletableFuture<Void>	clearAsync()
boolean	containsKey(Object key)
CompletableFuture<Boolean>	containsKeyAsync(Object key)
boolean	containsValue(Object value)
CompletableFuture<Boolean>	containsValueAsync(Object value)
@NotNull Set<Map.Entry<K,V>>	entrySet()
@NotNull CompletableFuture<Set<Map.Entry<K,V>>>	entrySetAsync()
V	get(Object key)
CompletableFuture<V>	getAsync(Object key)
@NotNull Database	getDb()
Executor	getExecutor()
@NotNull BiFunction<String,DbCollection,K>	getKeyFromString()
@NotNull BiFunction<K,DbCollection,String>	getKeyToString()
static <K, V> DbMap<K,V>	getMap(@NotNull Database db, @NotNull String name, @NotNull BiFunction<K,DbCollection,String> keyToString, @NotNull BiFunction<V,DbCollection,String> valueToString, @NotNull BiFunction<String,DbCollection,K> keyFromString, @NotNull BiFunction<String,DbCollection,V> valueFromString)	Gets a map from cache or creates a new one.
static <K, V> DbMap<K,V>	getMap(Database db, String name, Class<K> keyType, Class<V> valueType)	Gets a map from cache or creates a new one.
String	getName()
@NotNull String	getTable()
@NotNull BiFunction<String,DbCollection,V>	getValueFromString()
@NotNull BiFunction<V,DbCollection,String>	getValueToString()
boolean	isEmpty()
CompletableFuture<Boolean>	isEmptyAsync()
@NotNull Set<K>	keySet()
@NotNull CompletableFuture<Set<K>>	keySetAsync()
static <K, V> DbMap<K,V>	parseString(Database db, String s, BiFunction<K,DbCollection,String> keyToString, BiFunction<V,DbCollection,String> valueToString, BiFunction<String,DbCollection,K> keyFromString, BiFunction<String,DbCollection,V> valueFromString)	Parses a String representation of a DbMap into a DbMap.
V	put(K key, V value)
void	putAll(@NotNull Map<? extends K,? extends V> m)
CompletableFuture<Void>	putAllAsync(@NotNull Map<? extends K,? extends V> m)
@Nullable CompletableFuture<V>	putAsync(K key, V value)
V	remove(Object key)
CompletableFuture<V>	removeAsync(Object key)
CompletableFuture<Void>	runAsync(Runnable run)
<T> CompletableFuture<T>	runAsync(Supplier<T> sup)
void	setExecutor(Executor executor)
int	size()
CompletableFuture<Integer>	sizeAsync()
String	toString()
@NotNull Collection<V>	values()
@NotNull CompletableFuture<Collection<V>>	valuesAsync()

Methods inherited from class java.util.AbstractMap

clone, equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Method Details

parseString

public static <K,
V> DbMap<K,V> parseString(Database db,
 String s,
 BiFunction<K,DbCollection,String> keyToString,
 BiFunction<V,DbCollection,String> valueToString,
 BiFunction<String,DbCollection,K> keyFromString,
 BiFunction<String,DbCollection,V> valueFromString)

Parses a String representation of a DbMap into a DbMap.

Type Parameters:

K - The key type of this map.

V - The value type of this map.

Parameters:

db - The database this map belongs to. Used when creating a new map.

s - The String to parse.

keyToString - The function used to convert a key object of this map into a String. Used when creating a new map.

valueToString - The function used to convert a value object of this map into a String. Used when creating a new map.

keyFromString - The function used to convert a String into a key object of this map. Used when creating a new map.

valueFromString - The function used to convert a String into a value object of this map. Used when creating a new map.

Returns:

A new DbMap or a cached one if available.

getMap

public static <K,
V> DbMap<K,V> getMap(Database db,
 String name,
 Class<K> keyType,
 Class<V> valueType)

Gets a map from cache or creates a new one.

Type Parameters:

K - The type of the keys in this map.

V - The type of the values in this map.

Parameters:

db - The database this map belongs to. Used when creating a new map.

name - The name of this map.

keyType - The class of the type of the keys in this map, registered at DbCF. Used when creating a new map.

valueType - The class of the type of the values in this map, registered at DbCF. Used when creating a new map.

Returns:

A new DbMap or a cached one if available.

getMap

public static <K,
V> DbMap<K,V> getMap(@NotNull
 @NotNull Database db,
 @NotNull
 @NotNull String name,
 @NotNull
 @NotNull BiFunction<K,DbCollection,String> keyToString,
 @NotNull
 @NotNull BiFunction<V,DbCollection,String> valueToString,
 @NotNull
 @NotNull BiFunction<String,DbCollection,K> keyFromString,
 @NotNull
 @NotNull BiFunction<String,DbCollection,V> valueFromString)

Gets a map from cache or creates a new one.

Type Parameters:

K - The type of the keys in this map.

V - The type of the values in this map.

Parameters:

db - The database this map belongs to. Used when creating a new map.

name - The name of this map.

keyToString - The function used to convert a key object of this map into a String. Used when creating a new map.

valueToString - The function used to convert a value object of this map into a String. Used when creating a new map.

keyFromString - The function used to convert a String into a key object of this map. Used when creating a new map.

valueFromString - The function used to convert a String into a value object of this map. Used when creating a new map.

Returns:

A new DbMap or a cached one if available.

setExecutor

public void setExecutor(Executor executor)

getExecutor

public Executor getExecutor()

runAsync

public <T> CompletableFuture<T> runAsync(Supplier<T> sup)

runAsync

public CompletableFuture<Void> runAsync(Runnable run)

size

public int size()

Specified by:

size in interface Map<K,V>

Overrides:

size in class AbstractMap<K,V>

sizeAsync

public CompletableFuture<Integer> sizeAsync()

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

Overrides:

isEmpty in class AbstractMap<K,V>

isEmptyAsync

public CompletableFuture<Boolean> isEmptyAsync()

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

Overrides:

containsKey in class AbstractMap<K,V>

containsKeyAsync

public CompletableFuture<Boolean> containsKeyAsync(Object key)

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

Overrides:

containsValue in class AbstractMap<K,V>

containsValueAsync

public CompletableFuture<Boolean> containsValueAsync(Object value)

get

public V get(Object key)

Specified by:

get in interface Map<K,V>

Overrides:

get in class AbstractMap<K,V>

getAsync

public CompletableFuture<V> getAsync(Object key)

put

@Nullable
public V put(K key,
 V value)

Specified by:

put in interface Map<K,V>

Overrides:

put in class AbstractMap<K,V>

putAsync

@Nullable
public @Nullable CompletableFuture<V> putAsync(K key,
 V value)

remove

public V remove(Object key)

Specified by:

remove in interface Map<K,V>

Overrides:

remove in class AbstractMap<K,V>

removeAsync

public CompletableFuture<V> removeAsync(Object key)

putAll

public void putAll(@NotNull
 @NotNull Map<? extends K,? extends V> m)

Specified by:

putAll in interface Map<K,V>

Overrides:

putAll in class AbstractMap<K,V>

putAllAsync

public CompletableFuture<Void> putAllAsync(@NotNull
 @NotNull Map<? extends K,? extends V> m)

clear

public void clear()

Specified by:

clear in interface Map<K,V>

Overrides:

clear in class AbstractMap<K,V>

clearAsync

public CompletableFuture<Void> clearAsync()

keySet

@NotNull
public @NotNull Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

Overrides:

keySet in class AbstractMap<K,V>

keySetAsync

@NotNull
public @NotNull CompletableFuture<Set<K>> keySetAsync()

values

@NotNull
public @NotNull Collection<V> values()

Specified by:

values in interface Map<K,V>

Overrides:

values in class AbstractMap<K,V>

valuesAsync

@NotNull
public @NotNull CompletableFuture<Collection<V>> valuesAsync()

entrySet

@NotNull
public @NotNull Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

Specified by:

entrySet in class AbstractMap<K,V>

entrySetAsync

@NotNull
public @NotNull CompletableFuture<Set<Map.Entry<K,V>>> entrySetAsync()

toString

public String toString()

Overrides:

toString in class AbstractMap<K,V>

getDb

@NotNull
public @NotNull Database getDb()

Specified by:

getDb in interface DbCollection

Returns:

The database this collection works with.

getTable

@NotNull
public @NotNull String getTable()

Specified by:

getTable in interface DbCollection

Returns:

The table this collection works with.

getName

public String getName()

Specified by:

getName in interface DbCollection

Returns:

The name of this collection. Used to cache and parse from Strings.

getKeyToString

@NotNull
public @NotNull BiFunction<K,DbCollection,String> getKeyToString()

getValueToString

@NotNull
public @NotNull BiFunction<V,DbCollection,String> getValueToString()

getKeyFromString

@NotNull
public @NotNull BiFunction<String,DbCollection,K> getKeyFromString()

getValueFromString

@NotNull
public @NotNull BiFunction<String,DbCollection,V> getValueFromString()