com.avaya.conferencing.api.acp.control
Class EndPointQueue

java.lang.Object
  com.avaya.conferencing.api.acp.control.AbstractConferencingObject<EndPointQueue>
      com.avaya.conferencing.api.acp.control.EndPointQueue

All Implemented Interfaces:

ConferencingObject<EndPointQueue>, ConferencingObjectContainer<EndPointQueue>, ConferencingObjectQueue<EndPointQueue,EndPoint>, EndPointContainer<EndPointQueue>, java.lang.Iterable<EndPoint>

public abstract class EndPointQueue
extends AbstractConferencingObject<EndPointQueue>
implements ConferencingObjectQueue<EndPointQueue,EndPoint>, EndPointContainer<EndPointQueue>

Represents an ordered queue of EndPoints.

Since:

5.1.0.0.29

Nested Class Summary

Nested classes/interfaces inherited from interface com.avaya.conferencing.api.acp.control.ConferencingObjectQueue

ConferencingObjectQueue.Purpose, ConferencingObjectQueue.Purposes

Field Summary

Fields inherited from class com.avaya.conferencing.api.acp.control.AbstractConferencingObject

VERBOSE_TO_STRING

Fields inherited from interface com.avaya.conferencing.api.acp.control.ConferencingObjectQueue

ACTIVE, NAME, PURPOSES

Fields inherited from interface com.avaya.conferencing.api.acp.control.ConferencingObject

STATE

Constructor Summary

EndPointQueue()

Method Summary

void	addEndPointPropertyChangeListener(java.beans.PropertyChangeListener listener) Registers a PropertyChangeListener against all properties of the EndPoints in this container.
void	addEndPointPropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener) Registers a PropertyChangeListener against a specific property of the EndPoints in this container.
java.util.Iterator<EndPoint>	endPointIterator() Returns an iterator of the conference EndPoints.
java.util.Iterator<EndPoint>	endPointIterator(Filter<? super EndPoint>... filters) Returns an iterator of the conference EndPoints.
EndPoint	findEndPoint(Reference<EndPoint> ref) Find and retrieve the specified EndPoint.
java.util.List<EndPoint>	getEndPoints() Returns the EndPoints of this EndPointContainer.
java.util.List<EndPoint>	getEndPoints(Filter<? super EndPoint>... filters) Returns the EndPoints of this EndPointContainer which match a specific Filters.
java.lang.Class<EndPoint>	getEntryClass() Method getEntryClass returns the entryClass of this ConferencingObjectQueue object.
java.lang.String	getName() Returns the name of this EndPointQueue object.
java.util.Set<ConferencingObjectQueue.Purpose>	getPurposes() Returns the purposes of this queue.
boolean	isActive() Returns true if this EndPointQueue is connected.
EndPoint	lookupEndPoint(Reference<EndPoint> ref) Find and retrieve the specified EndPoints.
void	removeEndPointPropertyChangeListener(java.beans.PropertyChangeListener listener) Unregisters a PropertyChangeListener previously registered against all properties of the EndPoints in this container.
void	removeEndPointPropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener) Unregisters a PropertyChangeListener previously registered against a specific property of the EndPoints in this container.

Methods inherited from class com.avaya.conferencing.api.acp.control.AbstractConferencingObject

equals, execute, getVerbs, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.avaya.conferencing.api.acp.control.ConferencingObjectQueue

addEntryListener, addEntryListener, addEntryPropertyChangeListener, addEntryPropertyChangeListener, findEntry, getChildren, getChildren, getEntries, getEntries, isEmpty, iterator, lookupEntry, removeEntryListener, removeEntryListener, removeEntryPropertyChangeListener, removeEntryPropertyChangeListener

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface com.avaya.conferencing.api.acp.control.EndPointContainer

addDTMFListener, removeDTMFListener

Methods inherited from interface com.avaya.conferencing.api.acp.control.ConferencingObjectContainer

addChildListener, addChildListener, addChildPropertyChangeListener, addChildPropertyChangeListener, childClassIterator, childIterator, childIterator, findChild, findParents, getAllChildren, getAllChildren, getChildClasses, lookupChild, lookupParents, removeChildListener, removeChildListener, removeChildPropertyChangeListener, removeChildPropertyChangeListener

Methods inherited from interface com.avaya.conferencing.api.acp.control.ConferencingObject

addAvailableVerbsChangeListener, addPropertyChangeListener, addPropertyChangeListener, addStateChangeListener, execute, executeAs, getAllVerbs, getAllVerbsAs, getAllVerbsAs, getConnection, getId, getProperties, getProperties, getPropertyClass, getPropertyClasses, getPropertyType, getPropertyValue, getPropertyValues, getState, getVerbs, getVerbsAs, removeAvailableVerbsChangeListener, removePropertyChangeListener, removePropertyChangeListener, removeStateChangeListener

Constructor Detail

EndPointQueue

public EndPointQueue()

Method Detail

getEndPoints

public final java.util.List<EndPoint> getEndPoints()

Returns the EndPoints of this EndPointContainer. Implementations may use lazy-loading strategies to populate this collection, so collection.isEmpty() is preferable to 0 == collection.size() as the latter may block until the entire collection is loaded.

Specified by:

getEndPoints in interface EndPointContainer<EndPointQueue>

Returns:

The (possibly empty) immutable collection of EndPoints.

Since:

5.1.0.0.29

getEndPoints

public final java.util.List<EndPoint> getEndPoints(Filter<? super EndPoint>... filters)

Returns the EndPoints of this EndPointContainer which match a specific Filters. Implementations may use lazy-loading strategies to populate this collection, so collection.isEmpty() is preferable to 0 == collection.size() as the latter may block until the entire collection is loaded.

Specified by:

getEndPoints in interface EndPointContainer<EndPointQueue>

Parameters:

filters - The filters which must be matched.

Returns:

The (possibly empty) immutable collection of EndPoints.

Since:

5.1.0.0.29

getName

public final java.lang.String getName()

Returns the name of this EndPointQueue object.

Specified by:

getName in interface ConferencingObjectQueue<EndPointQueue,EndPoint>

Returns:

The name of this EndPointQueue object.

getPurposes

public final java.util.Set<ConferencingObjectQueue.Purpose> getPurposes()

Returns the purposes of this queue.

Specified by:

getPurposes in interface ConferencingObjectQueue<EndPointQueue,EndPoint>

Returns:

the purposes of this queue.

See Also:

ConferencingObjectQueue.Purpose

isActive

public final boolean isActive()

Returns true if this EndPointQueue is connected.

Specified by:

isActive in interface ConferencingObjectQueue<EndPointQueue,EndPoint>

Returns:

true if this EndPointQueue is connected.

endPointIterator

public final java.util.Iterator<EndPoint> endPointIterator(Filter<? super EndPoint>... filters)

Description copied from interface: EndPointContainer

Returns an iterator of the conference EndPoints.

Specified by:

endPointIterator in interface EndPointContainer<EndPointQueue>

Parameters:

filters - The filters to use.

Returns:

The iterator.

endPointIterator

public final java.util.Iterator<EndPoint> endPointIterator()

Description copied from interface: EndPointContainer

Returns an iterator of the conference EndPoints.

Specified by:

endPointIterator in interface EndPointContainer<EndPointQueue>

Returns:

The iterator.

findEndPoint

public final EndPoint findEndPoint(Reference<EndPoint> ref)
                            throws UnknownChildObjectException

Description copied from interface: EndPointContainer

Find and retrieve the specified EndPoint.

Specified by:

findEndPoint in interface EndPointContainer<EndPointQueue>

Parameters:

ref - The EndPoint reference.

Returns:

The EndPoint instance.

Throws:

UnknownChildObjectException - if the EndPoint does not exist.

lookupEndPoint

public final EndPoint lookupEndPoint(Reference<EndPoint> ref)

Description copied from interface: EndPointContainer

Find and retrieve the specified EndPoints.

Specified by:

lookupEndPoint in interface EndPointContainer<EndPointQueue>

Parameters:

ref - The EndPoint reference.

Returns:

The EndPoint instance or null if the EndPoint does not exist.

removeEndPointPropertyChangeListener

public final void removeEndPointPropertyChangeListener(java.lang.String property,
                                                       java.beans.PropertyChangeListener listener)

Description copied from interface: EndPointContainer

Unregisters a PropertyChangeListener previously registered against a specific property of the EndPoints in this container.

Specified by:

removeEndPointPropertyChangeListener in interface EndPointContainer<EndPointQueue>

Parameters:

property - The property to listen for changes on.

listener - The PropertyChangeListener.

removeEndPointPropertyChangeListener

public final void removeEndPointPropertyChangeListener(java.beans.PropertyChangeListener listener)

Description copied from interface: EndPointContainer

Unregisters a PropertyChangeListener previously registered against all properties of the EndPoints in this container.

Specified by:

removeEndPointPropertyChangeListener in interface EndPointContainer<EndPointQueue>

Parameters:

listener - The PropertyChangeListener.

addEndPointPropertyChangeListener

public final void addEndPointPropertyChangeListener(java.lang.String property,
                                                    java.beans.PropertyChangeListener listener)

Description copied from interface: EndPointContainer

Registers a PropertyChangeListener against a specific property of the EndPoints in this container.

Specified by:

addEndPointPropertyChangeListener in interface EndPointContainer<EndPointQueue>

Parameters:

property - The property to listen for changes on.

listener - The PropertyChangeListener.

addEndPointPropertyChangeListener

public final void addEndPointPropertyChangeListener(java.beans.PropertyChangeListener listener)

Description copied from interface: EndPointContainer

Registers a PropertyChangeListener against all properties of the EndPoints in this container.

Specified by:

addEndPointPropertyChangeListener in interface EndPointContainer<EndPointQueue>

Parameters:

listener - The PropertyChangeListener.

getEntryClass

public final java.lang.Class<EndPoint> getEntryClass()

Description copied from interface: ConferencingObjectQueue

Method getEntryClass returns the entryClass of this ConferencingObjectQueue object.

Specified by:

getEntryClass in interface ConferencingObjectQueue<EndPointQueue,EndPoint>

Returns:

the entry class (type Class) of this ConferencingObjectQueue object.