Module org.praxislive.base

Package org.praxislive.base

Class AbstractComponent

java.lang.Object

org.praxislive.base.AbstractComponent

All Implemented Interfaces:

Component

Direct Known Subclasses:

AbstractContainer

public abstract class AbstractComponent
extends Object
implements Component

Abstract base implementation of Component supporting Control and Port management. A ComponentProtocol.INFO control is added automatically, returning the information provided by the abstract Component.getInfo() method.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractComponent()

Method Summary

Modifier and Type	Method	Description
protected void	disconnectAll()
protected ComponentAddress	findService(Class<? extends Service> service)
protected ComponentAddress	getAddress()
Control	getControl(String id)	Get a Control that can handle a Call to the given ID, or null if it does not exist.
protected Lookup	getLookup()
Container	getParent()	Return the Container that is the immediate parent of this Component, or null if this Component is not currently contained within a Component hierarchy.
Port	getPort(String id)	Get the Port with the given ID, or null if it does not exist.
void	hierarchyChanged()	Notify the component that a change has happened in its component hierarchy.
void	parentNotify(Container parent)	Notify the Component that it has been added to the supplied Container, or removed from its parent if the supplied argument is null.
protected void	registerControl(String id, Control control)
protected void	registerPort(String id, Port port)
protected void	unregisterControl(String id)
protected void	unregisterPort(String id)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.praxislive.core.Component

getInfo

Constructor Detail

AbstractComponent

protected AbstractComponent()

Method Detail

getParent

public Container getParent()

Description copied from interface: Component

Return the Container that is the immediate parent of this Component, or null if this Component is not currently contained within a Component hierarchy.

Specified by:

getParent in interface Component

Returns:

Container

parentNotify

public void parentNotify(Container parent)
                  throws VetoException

Description copied from interface: Component

Notify the Component that it has been added to the supplied Container, or removed from its parent if the supplied argument is null. The Component may throw a VetoException if it should not be added to the Container provided. It should also throw this exception if a parent is already set.

Specified by:

parentNotify in interface Component

Throws:

VetoException

hierarchyChanged

public void hierarchyChanged()

Description copied from interface: Component

Notify the component that a change has happened in its component hierarchy. For example its direct parent or an ancestor has changed. This method will be called after parentNotify() if the result of an immediate parent change.

Specified by:

hierarchyChanged in interface Component

getControl

public Control getControl(String id)

Description copied from interface: Component

Get a Control that can handle a Call to the given ID, or null if it does not exist. Component implementations are free to return a different Control for each ID, a single control to handle any message, or somewhere in between. A null return from this method shall be handled by the Root component by responding with an error message to the sender where required.

Specified by:

getControl in interface Component

Returns:

Control or null

getPort

public Port getPort(String id)

Description copied from interface: Component

Get the Port with the given ID, or null if it does not exist.

Specified by:

getPort in interface Component

Returns:

Port or null

getAddress

protected ComponentAddress getAddress()

getLookup

protected Lookup getLookup()

findService

protected ComponentAddress findService(Class<? extends Service> service)
                                throws ServiceUnavailableException

Throws:

ServiceUnavailableException

disconnectAll

protected void disconnectAll()

registerControl

protected final void registerControl(String id,
                                     Control control)

unregisterControl

protected final void unregisterControl(String id)

registerPort

protected final void registerPort(String id,
                                  Port port)

unregisterPort

protected final void unregisterPort(String id)