org.springframework.data.keyvalue.core

Interface KeyValueAdapter

All Superinterfaces:

DisposableBean

All Known Implementing Classes:

AbstractKeyValueAdapter, MapKeyValueAdapter

public interface KeyValueAdapter
extends DisposableBean

KeyValueAdapter unifies access and shields the underlying key/value specific implementation.

Author:

Christoph Strobl, Thomas Darimont

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all objects.
boolean	contains(Serializable id, Serializable keyspace) Check if a object with given id exists in keyspace.
long	count(KeyValueQuery<?> query, Serializable keyspace) Count all matching objects within keyspace.
long	count(Serializable keyspace) Count number of objects within keyspace.
Object	delete(Serializable id, Serializable keyspace) Delete and return the obect with given type and id.
<T> T	delete(Serializable id, Serializable keyspace, Class<T> type)
void	deleteAllOf(Serializable keyspace) Remove all objects of given type.
CloseableIterator<Map.Entry<Serializable,Object>>	entries(Serializable keyspace) Returns a CloseableIterator that iterates over all entries.
Iterable<?>	find(KeyValueQuery<?> query, Serializable keyspace) Find all matching objects within keyspace.
<T> Iterable<T>	find(KeyValueQuery<?> query, Serializable keyspace, Class<T> type)
Object	get(Serializable id, Serializable keyspace) Get the object with given id from keyspace.
<T> T	get(Serializable id, Serializable keyspace, Class<T> type)
Iterable<?>	getAllOf(Serializable keyspace) Get all elements for given keyspace.
Object	put(Serializable id, Object item, Serializable keyspace) Add object with given id to keyspace.

Methods inherited from interface org.springframework.beans.factory.DisposableBean

destroy

Method Detail

put

Object put(Serializable id,
           Object item,
           Serializable keyspace)

Add object with given id to keyspace.

Parameters:

id - must not be null.

keyspace - must not be null.

Returns:

the item previously associated with the id.

contains

boolean contains(Serializable id,
                 Serializable keyspace)

Check if a object with given id exists in keyspace.

Parameters:

id - must not be null.

keyspace - must not be null.

Returns:

true if item of type with id exists.

get

Object get(Serializable id,
           Serializable keyspace)

Get the object with given id from keyspace.

Parameters:

id - must not be null.

keyspace - must not be null.

Returns:

null in case no matching item exists.

get

<T> T get(Serializable id,
          Serializable keyspace,
          Class<T> type)

Parameters:

id -

keyspace -

type -

Returns:

Since:

1.1

delete

Object delete(Serializable id,
              Serializable keyspace)

Delete and return the obect with given type and id.

Parameters:

id - must not be null.

keyspace - must not be null.

Returns:

null if object could not be found

delete

<T> T delete(Serializable id,
             Serializable keyspace,
             Class<T> type)

Parameters:

id -

keyspace -

type -

Returns:

Since:

1.1

getAllOf

Iterable<?> getAllOf(Serializable keyspace)

Get all elements for given keyspace.

Parameters:

keyspace - must not be null.

Returns:

empty Collection if nothing found.

entries

CloseableIterator<Map.Entry<Serializable,Object>> entries(Serializable keyspace)

Returns a CloseableIterator that iterates over all entries.

Parameters:

keyspace -

Returns:

deleteAllOf

void deleteAllOf(Serializable keyspace)

Remove all objects of given type.

Parameters:

keyspace - must not be null.

clear

void clear()

Removes all objects.

find

Iterable<?> find(KeyValueQuery<?> query,
                 Serializable keyspace)

Find all matching objects within keyspace.

Parameters:

query -

keyspace - must not be null.

Returns:

empty Collection if no match found.

find

<T> Iterable<T> find(KeyValueQuery<?> query,
                     Serializable keyspace,
                     Class<T> type)

Parameters:

query -

keyspace -

type -

Returns:

Since:

1.1

count

long count(Serializable keyspace)

Count number of objects within keyspace.

Parameters:

keyspace - must not be null.

count

long count(KeyValueQuery<?> query,
           Serializable keyspace)

Count all matching objects within keyspace.

Parameters:

query -

keyspace - must not be null.

Returns: