Class InstanceLifecycleEvent

  • All Implemented Interfaces:
    Serializable

    public class InstanceLifecycleEvent
    extends 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.

    Since:
    2.0
    Version:
    2.0
    See Also:
    Serialized Form
    • Constructor Detail

      • 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 Detail

      • getEventType

        public int getEventType()
        Returns the event type that triggered this event.
        Returns:
        the event type
        Since:
        2.0
      • 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.
        Overrides:
        getSource in class EventObject
        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"
      • 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"
      • 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"