com.avaya.conferencing.api.acp.control.events
Class ChildEvent<P,C>

java.lang.Object
  java.util.EventObject
      com.avaya.conferencing.api.acp.control.events.ChildEvent<P,C>

Type Parameters:

P - The parent that is the source of the event.

C - The child that is being added or removed from the parent.

All Implemented Interfaces:

java.io.Serializable

public class ChildEvent<P,C>
extends java.util.EventObject

A parent-child lifecycle event. Captures events in the parent-child lifecycle, i.e. child added or removed.

Since:

5.1.0.0.29

See Also:

ChildListener, Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

ChildEvent(P parent, C child, long sequenceNumber)
Constructs a prototypical Event.

Method Summary

C	getChild() Getter for property 'child'.
long	getSequenceNumber() The sequence number of this event for this parent object.
P	getSource() The object on which the Event initially occurred, that is the parent.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChildEvent

public ChildEvent(P parent,
                  C child,
                  long sequenceNumber)

Constructs a prototypical Event.

Parameters:

parent - The object on which the Event initially occurred.

child - The child object that triggered the event.

sequenceNumber - The sequence number of the specified parent instance for this event.

Throws:

java.lang.IllegalArgumentException - if source is null.

Since:

5.1.0.0.40

Method Detail

getChild

public C getChild()

Getter for property 'child'.

Returns:

Value for property 'child'.

Since:

5.1.0.0.29

getSource

public P getSource()

The object on which the Event initially occurred, that is the parent.

Overrides:

getSource in class java.util.EventObject

Returns:

The object on which the Event initially occurred, that is the parent.

Since:

5.1.0.0.29

getSequenceNumber

public long getSequenceNumber()

The sequence number of this event for this parent object. Each parent keeps a sequence number that is increased every time any ChildEvent is raised. The sequence number can therefore be used to determine the relative order of events. Implementations may use either event counting or the system clock (e.g. System.nanoTime()) to derive sequence numbers provided that the sequence numbers for events on the same source object are strictly increasing.

Returns:

The sequence number of this event for this parent instance.

Since:

5.1.0.0.40

See Also:

Monotonic and strictly increasing/decreasing functions

toString

public java.lang.String toString()

Overrides:

toString in class java.util.EventObject