Module spring.data.keyvalue

Package org.springframework.data.keyvalue.core.event

Class KeyValueEvent<T>

java.lang.Object

java.util.EventObject

org.springframework.context.ApplicationEvent

org.springframework.data.keyvalue.core.event.KeyValueEvent<T>

Type Parameters:

T -

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

KeyValueEvent.AfterDeleteEvent, KeyValueEvent.AfterDropKeySpaceEvent, KeyValueEvent.AfterGetEvent, KeyValueEvent.AfterInsertEvent, KeyValueEvent.AfterUpdateEvent, KeyValueEvent.BeforeDeleteEvent, KeyValueEvent.BeforeDropKeySpaceEvent, KeyValueEvent.BeforeGetEvent, KeyValueEvent.BeforeInsertEvent, KeyValueEvent.BeforeUpdateEvent

public class KeyValueEvent<T>
extends ApplicationEvent

KeyValueEvent gets published for operations executed by eg. KeyValueTemplate. Use the KeyValueEvent.KeyBasedEvent.getType() to determine which event has been emitted.

Author:

Christoph Strobl, Thomas Darimont, Mark Paluch

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KeyValueEvent.AfterDeleteEvent<T>	KeyValueEvent after removing an object by with a given key.
static class	KeyValueEvent.AfterDropKeySpaceEvent<T>	KeyValueEvent after removing all elements in a given keyspace.
static class	KeyValueEvent.AfterGetEvent<T>	KeyValueEvent after loading an object by its key.
static class	KeyValueEvent.AfterInsertEvent<T>	KeyValueEvent after inserting an object by with a given key.
static class	KeyValueEvent.AfterUpdateEvent<T>	KeyValueEvent after updating an object by with a given key.
static class	KeyValueEvent.BeforeDeleteEvent<T>	KeyValueEvent before removing an object by with a given key.
static class	KeyValueEvent.BeforeDropKeySpaceEvent<T>	KeyValueEvent before removing all elements in a given keyspace.
static class	KeyValueEvent.BeforeGetEvent<T>	KeyValueEvent raised before loading an object by its key.
static class	KeyValueEvent.BeforeInsertEvent<T>	KeyValueEvent before inserting an object by with a given key.
static class	KeyValueEvent.BeforeUpdateEvent<T>	KeyValueEvent before updating an object by with a given key.

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KeyValueEvent(Object source, String keyspace)

Method Summary

Modifier and Type	Method	Description
static <T> KeyValueEvent.AfterDeleteEvent<T>	afterDelete(Object id, String keyspace, Class<? extends T> type, T value)	Create new KeyValueEvent.AfterDeleteEvent.
static <T> KeyValueEvent.AfterDropKeySpaceEvent<T>	afterDropKeySpace(String keyspace, Class<? extends T> type)	Create new KeyValueEvent.AfterDropKeySpaceEvent.
static <T> KeyValueEvent.AfterGetEvent<T>	afterGet(Object id, String keyspace, Class<T> type, T value)	Create new KeyValueEvent.AfterGetEvent.
static <T> KeyValueEvent.AfterInsertEvent<T>	afterInsert(Object id, String keyspace, Class<? extends T> type, T value)	Create new KeyValueEvent.AfterInsertEvent.
static <T> KeyValueEvent.AfterUpdateEvent<T>	afterUpdate(Object id, String keyspace, Class<? extends T> type, T actualValue, Object previousValue)	Create new KeyValueEvent.AfterUpdateEvent.
static <T> KeyValueEvent.BeforeDeleteEvent<T>	beforeDelete(Object id, String keyspace, Class<? extends T> type)	Create new KeyValueEvent.BeforeDeleteEvent.
static <T> KeyValueEvent.BeforeDropKeySpaceEvent<T>	beforeDropKeySpace(String keyspace, Class<? extends T> type)	Create new KeyValueEvent.BeforeDropKeySpaceEvent.
static <T> KeyValueEvent.BeforeGetEvent<T>	beforeGet(Object id, String keyspace, Class<T> type)	Create new KeyValueEvent.BeforeGetEvent.
static <T> KeyValueEvent.BeforeInsertEvent<T>	beforeInsert(Object id, String keyspace, Class<? extends T> type, T value)	Create new KeyValueEvent.BeforeInsertEvent.
static <T> KeyValueEvent.BeforeUpdateEvent<T>	beforeUpdate(Object id, String keyspace, Class<? extends T> type, T value)	Create new KeyValueEvent.BeforeUpdateEvent.
String	getKeyspace()
String	toString()

Methods inherited from class org.springframework.context.ApplicationEvent

getTimestamp

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

KeyValueEvent

protected KeyValueEvent(Object source,
 String keyspace)

Method Details

getKeyspace

public String getKeyspace()

Returns:

affected keyspace. Never null.

toString

public String toString()

Overrides:

toString in class EventObject

beforeGet

public static <T> KeyValueEvent.BeforeGetEvent<T> beforeGet(Object id,
 String keyspace,
 Class<T> type)

Create new KeyValueEvent.BeforeGetEvent.

Parameters:

id -

keyspace -

type -

Returns:

afterGet

public static <T> KeyValueEvent.AfterGetEvent<T> afterGet(Object id,
 String keyspace,
 Class<T> type,
 @Nullable
 T value)

Create new KeyValueEvent.AfterGetEvent.

Parameters:

id -

keyspace -

type -

value -

Returns:

beforeInsert

public static <T>
KeyValueEvent.BeforeInsertEvent<T> beforeInsert(Object id,
 String keyspace,
 Class<? extends T> type,
 T value)

Create new KeyValueEvent.BeforeInsertEvent.

Parameters:

id -

keyspace -

type -

value -

Returns:

afterInsert

public static <T> KeyValueEvent.AfterInsertEvent<T> afterInsert(Object id,
 String keyspace,
 Class<? extends T> type,
 T value)

Create new KeyValueEvent.AfterInsertEvent.

Parameters:

id -

keyspace -

type -

value -

Returns:

beforeUpdate

public static <T>
KeyValueEvent.BeforeUpdateEvent<T> beforeUpdate(Object id,
 String keyspace,
 Class<? extends T> type,
 T value)

Create new KeyValueEvent.BeforeUpdateEvent.

Parameters:

id -

keyspace -

type -

value -

Returns:

afterUpdate

public static <T> KeyValueEvent.AfterUpdateEvent<T> afterUpdate(Object id,
 String keyspace,
 Class<? extends T> type,
 T actualValue,
 @Nullable
 Object previousValue)

Create new KeyValueEvent.AfterUpdateEvent.

Parameters:

id -

keyspace -

type -

actualValue -

previousValue -

Returns:

beforeDropKeySpace

public static <T>
KeyValueEvent.BeforeDropKeySpaceEvent<T> beforeDropKeySpace(String keyspace,
 Class<? extends T> type)

Create new KeyValueEvent.BeforeDropKeySpaceEvent.

Parameters:

keyspace -

type -

Returns:

afterDropKeySpace

public static <T>
KeyValueEvent.AfterDropKeySpaceEvent<T> afterDropKeySpace(String keyspace,
 Class<? extends T> type)

Create new KeyValueEvent.AfterDropKeySpaceEvent.

Parameters:

keyspace -

type -

Returns:

beforeDelete

public static <T>
KeyValueEvent.BeforeDeleteEvent<T> beforeDelete(Object id,
 String keyspace,
 Class<? extends T> type)

Create new KeyValueEvent.BeforeDeleteEvent.

Parameters:

id -

keyspace -

type -

Returns:

afterDelete

public static <T> KeyValueEvent.AfterDeleteEvent<T> afterDelete(Object id,
 String keyspace,
 Class<? extends T> type,
 @Nullable
 T value)

Create new KeyValueEvent.AfterDeleteEvent.

Parameters:

id -

keyspace -

type -

value -

Returns: