com.github.leanframeworks.minibus.base.channel

Class SimpleChannel

java.lang.Object

com.github.leanframeworks.minibus.base.channel.SimpleChannel

All Implemented Interfaces:

Channel

public class SimpleChannel
extends Object
implements Channel

Simple implementation of a channel.

The other channels it can flow into can be specified as sub-channels.

Note that two instances having the same contents will not be considered equal.

Constructor Summary

Constructors

Constructor and Description
SimpleChannel() Constructor.
SimpleChannel(Channel... subChannels) Constructor.
SimpleChannel(Collection<Channel> subChannels) Constructor.
SimpleChannel(String name) Constructor.
SimpleChannel(String name, Channel... subChannels) Constructor.
SimpleChannel(String name, Collection<Channel> subChannels) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addSubChannel(Channel channel) Adds the specified sub-channel into which this channel can flow.
boolean	flowsInto(Channel channel) States whether this channel flows into the specified channel.
String	getName() Gets the name of the channel, mostly useful for logging/debugging purposes.
Collection<Channel>	getSubChannels() Gets the sub-channels into which this channel can flow.
void	removeSubChannel(Channel channel) Removes the specified sub-channel into which this channel can no longer flow.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleChannel

public SimpleChannel()

Constructor.

A default, unique name will be used.

SimpleChannel

public SimpleChannel(Channel... subChannels)

Constructor.

A default, unique name will be used.

Parameters:

subChannels - Sub-channels into which this channel can flow.

SimpleChannel

public SimpleChannel(Collection<Channel> subChannels)

Constructor.

A default, unique name will be used.

Parameters:

subChannels - Sub-channels into which this channel can flow.

SimpleChannel

public SimpleChannel(String name)

Constructor.

If no name is given, a default, unique name will be used.

Parameters:

name - Name that can be used, for example, for logging or debugging purposes.

SimpleChannel

public SimpleChannel(String name,
                     Channel... subChannels)

Constructor.

If no name is given, a default, unique name will be used.

Parameters:

name - Name that can be used, for example, for logging or debugging purposes.

subChannels - Sub-channels into which this channel can flow.

SimpleChannel

public SimpleChannel(String name,
                     Collection<Channel> subChannels)

Constructor.

If no name is given, a default, unique name will be used.

Parameters:

name - Name that can be used, for example, for logging or debugging purposes.

subChannels - Sub-channels into which this channel can flow.

Method Detail

getName

public String getName()

Description copied from interface: Channel

Gets the name of the channel, mostly useful for logging/debugging purposes.

By default, the class's simple name followed by the instance's hash code.

Specified by:

getName in interface Channel

Returns:

Channel name.

See Also:

Channel.getName()

getSubChannels

public Collection<Channel> getSubChannels()

Gets the sub-channels into which this channel can flow.

Returns:

Sub-channels.

addSubChannel

public void addSubChannel(Channel channel)

Adds the specified sub-channel into which this channel can flow.

Parameters:

channel - Sub-channel to be added.

removeSubChannel

public void removeSubChannel(Channel channel)

Removes the specified sub-channel into which this channel can no longer flow.

Parameters:

channel - Sub-channel to be removed.

flowsInto

public boolean flowsInto(Channel channel)

Description copied from interface: Channel

States whether this channel flows into the specified channel.

By default, a channel only flows into itself.

Specified by:

flowsInto in interface Channel

Parameters:

channel - Channel to be checked (whether it accepts events from this channel).

Returns:

True if the specified channel accepts events from this channel, false otherwise.

See Also:

Channel.flowsInto(Channel)

toString

public String toString()

Overrides:

toString in class Object