javax.jdo.listener

Class InstanceLifecycleEvent


public class InstanceLifecycleEvent
extends java.util.EventObject

This is the event class used in life cycle event notifications.

Note that although InstanceLifecycleEvent inherits Serializable interface from EventObject, it is not intended to be Serializable. Appropriate serialization methods are implemented to throw NotSerializableException.

Version:
2.0
Since:
2.0

Field Summary

static int
ATTACH
static int
CLEAR
static int
CREATE
static int
DELETE
static int
DETACH
static int
DIRTY
static int
LOAD
static int
STORE

Constructor Summary

InstanceLifecycleEvent(Object source, int type)
Creates a new event object with the specified source and type.
InstanceLifecycleEvent(Object source, int type, Object target)
Creates a new event object with the specified source, type, and target.

Method Summary

Object
getDetachedInstance()
Returns the detached instance involved in the event.
int
getEventType()
Returns the event type that triggered this event.
Object
getPersistentInstance()
Returns the persistent instance involved in the event.
Object
getSource()
The source object of the Event.
Object
getTarget()
The target object of the Event.

Field Details

ATTACH

public static final int ATTACH
Field Value:
7

CLEAR

public static final int CLEAR
Field Value:
3

CREATE

public static final int CREATE
Field Value:
0

DELETE

public static final int DELETE
Field Value:
4

DETACH

public static final int DETACH
Field Value:
6

DIRTY

public static final int DIRTY
Field Value:
5

LOAD

public static final int LOAD
Field Value:
1

STORE

public static final int STORE
Field Value:
2

Constructor Details

InstanceLifecycleEvent

public InstanceLifecycleEvent(Object source,
                              int type)
Creates a new event object with the specified source and type.
Parameters:
source - the instance that triggered the event
type - the event type
Since:
2.0

InstanceLifecycleEvent

public InstanceLifecycleEvent(Object source,
                              int type,
                              Object target)
Creates a new event object with the specified source, type, and target.
Parameters:
source - the instance that triggered the event
type - the event type
target - the "other" instance
Since:
2.0

Method Details

getDetachedInstance

public Object getDetachedInstance()
Returns the detached instance involved in the event.
Returns:
The detached instance involved in the event, or null if there was none.
See Also:
"Section 12.15, Java Data Objects 2.0 Specification"

getEventType

public int getEventType()
Returns the event type that triggered this event.
Returns:
the event type
Since:
2.0

getPersistentInstance

public Object getPersistentInstance()
Returns the persistent instance involved in the event.
Returns:
The persistent instance involved in the event, or null if there was none.
See Also:
"Section 12.15, Java Data Objects 2.0 Specification"

getSource

public Object getSource()
The source object of the Event. Although not deprecated, it is recommended that the the methods getPersistentInstance() and getDetachedInstance() be used instead.
Returns:
The persistent instance on any pre- callback except preAttach, or the detached instance for a postDetach or preAttach callback.
See Also:
getPersistentInstance(), getDetachedInstance(), "Section 12.15, Java Data Objects 2.0 Specification"

getTarget

public Object getTarget()
The target object of the Event. Although not deprecated, it is recommended that the the methods getPersistentInstance() and getDetachedInstance() be used instead.
Returns:
The detached instance for preDetach and postAttach, the persistent instance otherwise.
Since:
2.0
See Also:
getPersistentInstance(), getDetachedInstance(), "Section 12.15, Java Data Objects 2.0 Specification"