Package com.adaptris.core

Class ChannelList

java.lang.Object

java.util.AbstractCollection<Channel>

com.adaptris.core.ChannelList

All Implemented Interfaces:

ComponentLifecycle, ComponentLifecycleExtension, java.lang.Iterable<Channel>, java.util.Collection<Channel>, java.util.List<Channel>

@ComponentProfile(summary="A Collection of Channels",
                  tag="base")
public class ChannelList
extends java.util.AbstractCollection<Channel>
implements ComponentLifecycle, java.util.List<Channel>, ComponentLifecycleExtension

Container for a collection of Channel objects

In the adapter configuration file this class is aliased as channel-list which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor	Description
ChannelList()	Creates a new instance.
ChannelList(java.util.Collection<Channel> coll)

Method Summary

Modifier and Type	Method	Description
void	add(int index, Channel element)
boolean	add(Channel element)
boolean	addAll(int index, java.util.Collection<? extends Channel> c)
void	addChannel(Channel channel)	Adds a Channel to the underlying List and validates its unique ID.
void	clear()
void	close()	Uses the the configured ChannelLifecycleStrategy to invoke StateManagedComponent.requestClose() on the underlying Channels in the List.
Channel	get(int index)
Channel	getChannel(int pos)	Returns the Channel stored at the passed pos in the List.
Channel	getChannel(java.lang.String uniqueId)	Returns the Channel with the passed uniqueId or null if no such channel exists.
java.util.List<Channel>	getChannels()	Returns the underlying List of Channels.
ChannelLifecycleStrategy	getLifecycleStrategy()
int	indexOf(java.lang.Object o)
void	init()	Uses the the configured ChannelLifecycleStrategy to invoke StateManagedComponent.requestInit() on the underlying Channels in the List.
java.util.Iterator<Channel>	iterator()
int	lastIndexOf(java.lang.Object o)
java.util.ListIterator<Channel>	listIterator()
java.util.ListIterator<Channel>	listIterator(int index)
void	prepare()	Make sure we are ready for initialisation.
Channel	remove(int index)
boolean	remove(java.lang.Object o)
boolean	removeChannel(Channel channel)	Remove a channel from this channel list.
Channel	set(int index, Channel element)
void	setChannels(java.util.List<Channel> l)	Set the underlying List of Channels.
void	setLifecycleStrategy(ChannelLifecycleStrategy css)	Specify the strategy to use when handling channel lifecycle.
int	size()	Returns the number of Channel s in this ChannelList.
void	start()	Uses the the configured ChannelLifecycleStrategy to invoke StateManagedComponent.requestStart() on the underlying Channels in the List.
void	stop()	Uses the the configured ChannelLifecycleStrategy to invoke StateManagedComponent.requestStop() on the underlying Channels in the List.
java.util.List<Channel>	subList(int fromIndex, int toIndex)

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addAll, contains, containsAll, equals, hashCode, isEmpty, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Constructor Detail

ChannelList

public ChannelList()

Creates a new instance.

ChannelList

public ChannelList(java.util.Collection<Channel> coll)

Method Detail

prepare

public void prepare()
             throws CoreException

Make sure we are ready for initialisation.

Specified by:

prepare in interface ComponentLifecycleExtension

Throws:

CoreException

init

public void init()
          throws CoreException

Uses the the configured ChannelLifecycleStrategy to invoke StateManagedComponent.requestInit() on the underlying Channels in the List.

Specified by:

init in interface ComponentLifecycle

Throws:

CoreException - wrapping any underlying Exception s

start

public void start()
           throws CoreException

Uses the the configured ChannelLifecycleStrategy to invoke StateManagedComponent.requestStart() on the underlying Channels in the List.

Specified by:

start in interface ComponentLifecycle

Throws:

CoreException - wrapping any underlying Exceptions

stop

public void stop()

Uses the the configured ChannelLifecycleStrategy to invoke StateManagedComponent.requestStop() on the underlying Channels in the List.

Specified by:

stop in interface ComponentLifecycle

close

public void close()

Uses the the configured ChannelLifecycleStrategy to invoke StateManagedComponent.requestClose() on the underlying Channels in the List.

Specified by:

close in interface ComponentLifecycle

getChannels

public java.util.List<Channel> getChannels()

Returns the underlying List of Channels.

Returns:

the underlying List of Channels

setChannels

public void setChannels(java.util.List<Channel> l)

Set the underlying List of Channels.

Parameters:

l - the underlying List of Channels

addChannel

public void addChannel(Channel channel)

Adds a Channel to the underlying List and validates its unique ID.

Parameters:

channel - the Channel to add

getChannel

public Channel getChannel(int pos)

Returns the Channel stored at the passed pos in the List.

Parameters:

pos - the position in the List

Returns:

the Channel stored at the passed pos in the List

size

public int size()

Returns the number of Channel s in this ChannelList.

Specified by:

size in interface java.util.Collection<Channel>

Specified by:

size in interface java.util.List<Channel>

Specified by:

size in class java.util.AbstractCollection<Channel>

Returns:

the number of Channel s in this ChannelList

getChannel

public Channel getChannel(java.lang.String uniqueId)

Returns the Channel with the passed uniqueId or null if no such channel exists.

Parameters:

uniqueId - the unique ID of the Channel to return, may not be null or empty

Returns:

the requested Channel or null if it doesn't exist, will always be null unless prepare() has been called.

getLifecycleStrategy

public ChannelLifecycleStrategy getLifecycleStrategy()

Returns:

the startStrategy

setLifecycleStrategy

public void setLifecycleStrategy(ChannelLifecycleStrategy css)

Specify the strategy to use when handling channel lifecycle.

If not explicitly specified, then DefaultChannelLifecycleStrategy will be used to handle the channel operations.

Parameters:

css - the strategy to set

See Also:

DefaultChannelLifecycleStrategy, NonBlockingChannelStartStrategy

iterator

public java.util.Iterator<Channel> iterator()

Specified by:

iterator in interface java.util.Collection<Channel>

Specified by:

iterator in interface java.lang.Iterable<Channel>

Specified by:

iterator in interface java.util.List<Channel>

Specified by:

iterator in class java.util.AbstractCollection<Channel>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<Channel>

Specified by:

remove in interface java.util.List<Channel>

Overrides:

remove in class java.util.AbstractCollection<Channel>

removeChannel

public boolean removeChannel(Channel channel)

Remove a channel from this channel list.

Parameters:

channel -

Returns:

true if the channel was removed successfully.

add

public boolean add(Channel element)

Specified by:

add in interface java.util.Collection<Channel>

Specified by:

add in interface java.util.List<Channel>

Overrides:

add in class java.util.AbstractCollection<Channel>

add

public void add(int index,
                Channel element)

Specified by:

add in interface java.util.List<Channel>

addAll

public boolean addAll(int index,
                      java.util.Collection<? extends Channel> c)

Specified by:

addAll in interface java.util.List<Channel>

get

public Channel get(int index)

Specified by:

get in interface java.util.List<Channel>

indexOf

public int indexOf(java.lang.Object o)

Specified by:

indexOf in interface java.util.List<Channel>

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Specified by:

lastIndexOf in interface java.util.List<Channel>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<Channel>

Specified by:

clear in interface java.util.List<Channel>

Overrides:

clear in class java.util.AbstractCollection<Channel>

listIterator

public java.util.ListIterator<Channel> listIterator()

Specified by:

listIterator in interface java.util.List<Channel>

listIterator

public java.util.ListIterator<Channel> listIterator(int index)

Specified by:

listIterator in interface java.util.List<Channel>

remove

public Channel remove(int index)

Specified by:

remove in interface java.util.List<Channel>

set

public Channel set(int index,
                   Channel element)

Specified by:

set in interface java.util.List<Channel>

subList

public java.util.List<Channel> subList(int fromIndex,
                                       int toIndex)

Specified by:

subList in interface java.util.List<Channel>