org.eclipse.ecf.datashare
Interface IAbstractChannelContainer

All Known Subinterfaces:
IChannelContainer, IMergeableChannelContainer
All Known Implementing Classes:
DatashareContainer, DatashareContainerAdapter, SharedObjectDatashareContainerAdapter

public interface IAbstractChannelContainer

Abstract channel container


Method Summary
 void addListener(IChannelContainerListener listener)
          Add listener for IChannelContainer events.
 IChannel getChannel(ID channelID)
          Get IChannel with given channelID.
 Namespace getChannelNamespace()
          Get expected Namespace for channel ID creation
 boolean removeChannel(ID channelID)
          Remove channel with given ID
 void removeListener(IChannelContainerListener listener)
          Remove listener for IChannelContainer events
 

Method Detail

addListener

void addListener(IChannelContainerListener listener)
Add listener for IChannelContainer events.

Parameters:
listener - to be added

removeListener

void removeListener(IChannelContainerListener listener)
Remove listener for IChannelContainer events

Parameters:
listener - to be removed.

getChannelNamespace

Namespace getChannelNamespace()
Get expected Namespace for channel ID creation

Returns:
Namespace that can be used to create channel ID instances for this channel container

getChannel

IChannel getChannel(ID channelID)
Get IChannel with given channelID.

Parameters:
channelID - the ID of the channel to get
Returns:
IChannel of channel within container with given ID. Returns null if channel not found.

removeChannel

boolean removeChannel(ID channelID)
Remove channel with given ID

Parameters:
channelID - the ID of the channel to Remove within this container
Returns:
true if channel found and Removed. False if channel not found within container.