com.adaptris.core.runtime

Interface ParentComponent<S>

All Superinterfaces:

BaseComponentMBean, ParentComponentMBean

All Known Subinterfaces:

AdapterRuntimeManager, ChannelRuntimeManager

All Known Implementing Classes:

AdapterManager, ChannelManager

public interface ParentComponent<S>
extends ParentComponentMBean

Basic interface of MBeans that contain child member components.

Method Summary

Modifier and Type	Method and Description
boolean	addChild(S wmb) Add a a child to this parent.
boolean	addChildren(java.util.Collection<S> coll) Add some children to this parent (optional operation).
void	childUpdated() Notifies a parent that a child component has been updated.
java.lang.String	createObjectHierarchyString() Create an ObjectName key/value pair hierarchy.
java.util.Collection<BaseComponentMBean>	getAllDescendants() Get all the descendants of this ParentComponent implementation.
boolean	removeChild(S wmb) Remove a Child from this parent.
boolean	removeChildren(java.util.Collection<S> coll) Remove some children from this parent.

Methods inherited from interface com.adaptris.core.runtime.ParentComponentMBean

getChildren

Methods inherited from interface com.adaptris.core.runtime.BaseComponentMBean

createObjectName, registerMBean, unregisterMBean

Method Detail

createObjectHierarchyString

java.lang.String createObjectHierarchyString()

Create an ObjectName key/value pair hierarchy.

Returns:

a hierarchy based on the tree.

addChild

boolean addChild(S wmb)
          throws CoreException

Add a a child to this parent.

Parameters:

wmb - a channel manager

Returns:

true if the underlying components were modified.

Throws:

CoreException - wrapping any underlying exception

See Also:

Set.add(Object)

removeChild

boolean removeChild(S wmb)
             throws CoreException

Remove a Child from this parent.

Parameters:

wmb - a channel manager

Returns:

true if the component existed as a child

Throws:

CoreException - wrapping any underlying exception

See Also:

Set.remove(Object)

addChildren

boolean addChildren(java.util.Collection<S> coll)
             throws CoreException,
                    java.lang.UnsupportedOperationException

Add some children to this parent (optional operation).

Parameters:

coll - a collection of items to be added.

Returns:

true if the underlying components were modified.

Throws:

CoreException - wrapping any underlying exception

java.lang.UnsupportedOperationException - - if the addChildren operation is not supported.

See Also:

Set.addAll(Collection)

removeChildren

boolean removeChildren(java.util.Collection<S> coll)
                throws CoreException

Remove some children from this parent.

Parameters:

coll - a collection of items to be removed.

Returns:

true if the underlying components were modified.

Throws:

CoreException - wrapping any underlying exception

See Also:

Set.addAll(Collection)

getAllDescendants

java.util.Collection<BaseComponentMBean> getAllDescendants()

Get all the descendants of this ParentComponent implementation.

Returns:

all the children, and children's children, etc...

childUpdated

void childUpdated()
           throws CoreException

Notifies a parent that a child component has been updated.

Throws:

CoreException