Interface DataStore<V> (1.45.1)

public interface DataStore<V>

Stores and manages serializable data of a specific type, where the key is a string and the value is a Serializable object.

null keys or values are not allowed. Implementation should be thread-safe.

Type Parameter
Name	Description
`V`

Methods

clear()

public abstract DataStore<V> clear()

Deletes all of the stored keys and values.

Returns
Type	Description
`DataStore<V>`

Exceptions
Type	Description
`IOException`

containsKey(String key)

public abstract boolean containsKey(String key)

Returns whether the store contains the given key.

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`IOException`

containsValue(V value)

public abstract boolean containsValue(V value)

Returns whether the store contains the given value.

Parameter
Name	Description
`value`	`V`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`IOException`

delete(String key)

public abstract DataStore<V> delete(String key)

Deletes the stored key and value based on the given key, or ignored if the key doesn't already exist.

Parameter
Name	Description
`key`	`String` key or `null` to ignore

Returns
Type	Description
`DataStore<V>`

Exceptions
Type	Description
`IOException`

get(String key)

public abstract V get(String key)

Returns the stored value for the given key or null if not found.

Parameter
Name	Description
`key`	`String` key or `null` for `null` result

Returns
Type	Description
`V`

Exceptions
Type	Description
`IOException`

getDataStoreFactory()

public abstract DataStoreFactory getDataStoreFactory()

Returns the data store factory.

Returns
Type	Description
`DataStoreFactory`

getId()

public abstract String getId()

Returns the data store ID.

Returns
Type	Description
`String`

isEmpty()

public abstract boolean isEmpty()

Returns whether there are any stored keys.

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`IOException`

keySet()

public abstract Set<String> keySet()

Returns the unmodifiable set of all stored keys.

Order of the keys is not specified.

Returns
Type	Description
`Set<String>`

Exceptions
Type	Description
`IOException`

set(String key, V value)

public abstract DataStore<V> set(String key, V value)

Stores the given value for the given key (replacing any existing value).

Parameters
Name	Description
`key`	`String` key
`value`	`V` value object

Returns
Type	Description
`DataStore<V>`

Exceptions
Type	Description
`IOException`

size()

public abstract int size()

Returns the number of stored keys.

Returns
Type	Description
`int`

Exceptions
Type	Description
`IOException`

values()

public abstract Collection<V> values()

Returns the unmodifiable collection of all stored values.

Returns
Type	Description
`Collection<V>`

Exceptions
Type	Description
`IOException`