org.eclipse.core.commands.common
Class HandleObjectManager

java.lang.Object
  extended by org.eclipse.core.commands.common.EventManager
      extended by org.eclipse.core.commands.common.HandleObjectManager
Direct Known Subclasses:
CommandManager, ContextManager

public abstract class HandleObjectManager
extends EventManager

A manager of HandleObject instances. This has some common behaviour which is shared between all such managers.

Clients may extend.

Since:
3.2

Field Summary
protected  java.util.Set definedHandleObjects
          The set of handle objects that are defined.
protected  java.util.Map handleObjectsById
          The map of identifiers (String) to handle objects ( HandleObject).
 
Constructor Summary
HandleObjectManager()
           
 
Method Summary
protected  void checkId(java.lang.String id)
          Verifies that the identifier is valid.
protected  java.util.Set getDefinedHandleObjectIds()
          Returns the set of identifiers for those handle objects that are defined.
 
Methods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

definedHandleObjects

protected final java.util.Set definedHandleObjects
The set of handle objects that are defined. This value may be empty, but it is never null.


handleObjectsById

protected final java.util.Map handleObjectsById
The map of identifiers (String) to handle objects ( HandleObject). This collection may be empty, but it is never null.

Constructor Detail

HandleObjectManager

public HandleObjectManager()
Method Detail

checkId

protected final void checkId(java.lang.String id)
Verifies that the identifier is valid. Exceptions will be thrown if the identifier is invalid in some way.

Parameters:
id - The identifier to validate; may be anything.

getDefinedHandleObjectIds

protected final java.util.Set getDefinedHandleObjectIds()
Returns the set of identifiers for those handle objects that are defined.

Returns:
The set of defined handle object identifiers; this value may be empty, but it is never null.