Package org.eclipse.ecf.core
Interface IContainerManager
- 
- All Known Implementing Classes:
- ContainerFactory
 
 public interface IContainerManagerContainer manager for getting access to existing container instances previously created viaIContainerFactory.
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description IContaineraddContainer(IContainer container, ContainerTypeDescription typeDescription)Add given container to manager.booleanaddListener(IContainerManagerListener listener)Add listener to thisIContainerManager.IContainer[]getAllContainers()Get all containers known to this container manager.IContainergetContainer(ID containerID)Get container for given ID.IContainerFactorygetContainerFactory()Get container factory associated with this container manager.ContainerTypeDescriptiongetContainerTypeDescription(ID containerID)Get the container type description used to create the container with the given ID.booleanhasContainer(ID containerID)Return true if this container manager has the given container under management, false otherwise.voidremoveAllContainers()Remove all containers from this managerIContainerremoveContainer(IContainer container)Remove given container from manager.IContainerremoveContainer(ID containerID)Remove given container from manager.booleanremoveListener(IContainerManagerListener listener)Remove listener from thisIContainerManager.
 
- 
- 
- 
Method Detail- 
getContainerFactoryIContainerFactory getContainerFactory() Get container factory associated with this container manager.- Returns:
- IContainerFactory.  Will not return null.
- Since:
- 3.0
 
 - 
getContainerIContainer getContainer(ID containerID) Get container for given ID. IfcontainerIDisnullthennullwill be returned. If active container with givencontainerID,is not known to this container manager, thennullwill also be returned.- Parameters:
- containerID- the ID of the container instance to retrieve from this manager. If- null- nullwill be returned.
- Returns:
- IContainer instance with given containerID. Will benullif there is no container with given ID known to this container manager.
 
 - 
getContainerTypeDescriptionContainerTypeDescription getContainerTypeDescription(ID containerID) Get the container type description used to create the container with the given ID.- Parameters:
- containerID- the ID of the container to get the description for.
- Returns:
- ContainerTypeDescription for the container with the given ID.  Will return nullif no container with the given containerID exists under this manager.
 
 - 
getAllContainersIContainer[] getAllContainers() Get all containers known to this container manager.- Returns:
- IContainer[] of active container instances known to this
         container manager. Will not return null, but may return empty IContainer[].
 
 - 
hasContainerboolean hasContainer(ID containerID) Return true if this container manager has the given container under management, false otherwise.- Parameters:
- containerID- the ID of the container to find. If- nullthis method returns false.
- Returns:
- true if this container manager has the given container under management, false otherwise.
 
 - 
addContainerIContainer addContainer(IContainer container, ContainerTypeDescription typeDescription) Add given container to manager.- Parameters:
- container- to add. Must not be- null. Also- container.getID()must return a non-- nullvalue. If- container.getID()returns- nullthen this method will throw a- NullPointerException.
- typeDescription- the container type description used to create the given container. Must not be- null.
- Returns:
- IContainer previously added (with same ID).
 
 - 
removeContainerIContainer removeContainer(IContainer container) Remove given container from manager.- Parameters:
- container- the container to remove. Must not be- null.
- Returns:
- IContainer instance removed.  If no instance with same ID is found
 then nullwill be returned.
 
 - 
removeContainerIContainer removeContainer(ID containerID) Remove given container from manager.- Parameters:
- containerID- the ID of the container to remove. Must not be- null.
- Returns:
- IContainer instance removed.  If no instance with same ID is found
 then nullwill be returned.
- Since:
- 3.0
 
 - 
addListenerboolean addListener(IContainerManagerListener listener) Add listener to thisIContainerManager.- Parameters:
- listener- the listener to add. Must not be- null.
- Returns:
- true if listener successfully added
 
 - 
removeListenerboolean removeListener(IContainerManagerListener listener) Remove listener from thisIContainerManager.- Parameters:
- listener- the listener to remove. Must not be- null.
- Returns:
- true if listener successfully removed
 
 - 
removeAllContainersvoid removeAllContainers() Remove all containers from this manager- Since:
- 3.0
 
 
- 
 
-