org.eclipse.ecf.datashare
Class BaseChannelConfig

java.lang.Object
  org.eclipse.ecf.datashare.BaseChannelConfig

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, IIdentifiable, IChannelConfig

public class BaseChannelConfig
extends java.lang.Object
implements IChannelConfig

Base class implementation of IChannelConfig. Subclasses may be created as appropriate.

Field Summary

protected ID	id
protected IChannelListener	listener
protected java.util.Map	properties

Constructor Summary

BaseChannelConfig()

BaseChannelConfig(ID id, IChannelListener listener, java.util.Map properties)

Method Summary

java.lang.Object	getAdapter(java.lang.Class adapter)
ID	getID() Return the ID for this 'identifiable' object.
IChannelListener	getListener() Get listener for channel being created.
java.util.Map	getProperties() Get properties for new channel creation

Methods inherited from class java.lang.Object

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

Field Detail

id

protected ID id

listener

protected IChannelListener listener

properties

protected java.util.Map properties

Constructor Detail

BaseChannelConfig

public BaseChannelConfig()

BaseChannelConfig

public BaseChannelConfig(ID id,
                         IChannelListener listener,
                         java.util.Map properties)

Method Detail

getListener

public IChannelListener getListener()

Description copied from interface: IChannelConfig

Get listener for channel being created. Typically, provider will call this method during the implementation of createChannel. If this method returns a non-null IChannelListener instance, the newly created channel must notify the given listener when channel events occur. If this method returns null, then no listener will be notified of channel events

Specified by:

getListener in interface IChannelConfig

Returns:

IChannelListener to use for notification of received channel events. If null, then no listener will be notified of channel events.

getID

public ID getID()

Description copied from interface: IIdentifiable

Return the ID for this 'identifiable' object. The returned ID should be unique within its namespace. May return null.

Specified by:

getID in interface IIdentifiable

Returns:

the ID for this identifiable object. May return null.

getProperties

public java.util.Map getProperties()

Description copied from interface: IChannelConfig

Get properties for new channel creation

Specified by:

getProperties in interface IChannelConfig

Returns:

Map with properties for new channel

getAdapter

public java.lang.Object getAdapter(java.lang.Class adapter)

Specified by:

getAdapter in interface org.eclipse.core.runtime.IAdaptable