org.jacpfx.api.component

Interface SubComponent<L,A,M>

Type Parameters:

L - defines the message listener type

A - defines the basic event type

M - defines the basic message type

All Superinterfaces:

java.lang.Comparable<ComponentBase<L,M>>, ComponentBase<L,M>

All Known Subinterfaces:

StatelessCallabackComponent<L,A,M>, UIComponent<C,L,A,M>

public interface SubComponent<L,A,M>
extends ComponentBase<L,M>

Defines a subcomponent handled by a root component. A subcomponent is running in a perspective environment an can be represented by an visible UI or non visible background component.

Author:

Andy Moncsek

Method Summary

Modifier and Type	Method and Description
<X extends ComponentHandle<?,A,M>> X	getComponent() Returns the component handle class, this is the users implementation of the component.
Message<A,M>	getNextIncomingMessage() Returns next message in pipe.
boolean	hasIncomingMessage() Returns true if component has message in pipe.
void	initEnv(java.lang.String parentId, java.util.concurrent.TransferQueue<Message<A,M>> messageQueue) Set parentId and global message queue to component
boolean	isBlocked() Component is blocked when executed in thread.
void	lock() Lock Component for execution in thread.
void	putIncomingMessage(Message<A,M> message) Add new message to component.
void	release() Release lock after execution in thread.
<X extends ComponentHandle<?,A,M>> void	setComponent(X handle) Set the component handle class.

Methods inherited from interface org.jacpfx.api.component.ComponentBase

getContext, getLocaleID, getResourceBundleLocation, isStarted, setLocaleID, setResourceBundleLocation, setStarted

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

hasIncomingMessage

boolean hasIncomingMessage()

Returns true if component has message in pipe.

Returns:

returns true if incoming message is in queue

putIncomingMessage

void putIncomingMessage(Message<A,M> message)

Add new message to component.

Parameters:

message, - the message.

getNextIncomingMessage

Message<A,M> getNextIncomingMessage()
                             throws java.lang.InterruptedException

Returns next message in pipe.

Returns:

the next message to handle

Throws:

java.lang.InterruptedException - , the Exception will be thrown when main thread is interrupted and not delegated to the developer

isBlocked

boolean isBlocked()

Component is blocked when executed in thread.

Returns:

blocked state

lock

void lock()

Lock Component for execution in thread.

release

void release()

Release lock after execution in thread.

initEnv

void initEnv(java.lang.String parentId,
             java.util.concurrent.TransferQueue<Message<A,M>> messageQueue)

Set parentId and global message queue to component

Parameters:

parentId, - the parent id of the current component (the perspective id)

messageQueue, - the message queue

getComponent

<X extends ComponentHandle<?,A,M>> X getComponent()

Returns the component handle class, this is the users implementation of the component.

Parameters:

, - the type

Returns:

ComponentHandle, the component handle.

setComponent

<X extends ComponentHandle<?,A,M>> void setComponent(X handle)

Set the component handle class. This is the users implementation of the component.

Parameters:

handle, - the component

, - the type