Package org.jgrapes.core

Class Component

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

All Implemented Interfaces:

Iterable<ComponentType>, Channel, ComponentType, Eligible, Manager

Direct Known Subclasses:

ComponentCollector, ComponentProvider, ConfigurationStore, ConnectionManager, FileStorage, FileSystemWatcher, FreeMarkerRequestHandler, HttpConnector, HttpServer, InputStreamMonitor, LanguageSelector, NioDispatcher, ProcessManager, PurgeTerminator, SessionManager, SocketConnectionManager, SslCodec, StaticContentDispatcher

public abstract class Component
extends ComponentVertex
implements ComponentType, Channel

This class can be used as base class for implementing a component.

This class implements the Manager interface. Contrary to classes that only implement ComponentType, derived classes therefore don't need a manager attribute to get access to the component management methods provided by this interface.

This class also implements the Channel interface in such a way that each instance of this class can be used as an independent channel. Note that events that have a component as one of their channels are always handled by the component's handlers, i.e. in addition to the channels explicitly defined for a handler.

See Also:

• Handler
• ComponentType

Nested Class Summary

Nested classes/interfaces inherited from interface org.jgrapes.core.Channel

Channel.Default

Field Summary

Fields

Modifier and Type	Field	Description
protected final Logger	logger

Fields inherited from interface org.jgrapes.core.Channel

BROADCAST, SELF

Constructor Summary

Constructors

Constructor	Description
Component()	Creates a new component base with its channel set to itself.
Component(Channel componentChannel)	Creates a new component base with its channel set to the given channel.
Component(Channel componentChannel, HandlerDefinition.ChannelReplacements channelReplacements)	Creates a new component base like Component(Channel) but with channel mappings for Handler annotations.

Method Summary

Modifier and Type	Method	Description
Channel	channel()	Returns the channel associated with the component.
Component	component()	Returns the component represented by this node in the tree.
Object	defaultCriterion()	Return the object itself as value.
boolean	isEligibleFor(Object value)	Matches the object itself (using identity comparison) or the Channel class.
Component	setName(String name)	Sets the (optional) name of the component.

Methods inherited from class org.jgrapes.core.internal.ComponentVertex

activeEventPipeline, addHandler, attach, channelReplacements, children, componentPath, componentVertex, detach, fire, initComponentsHandlers, iterator, name, newEventPipeline, newEventPipeline, parent, registerAsGenerator, root, toString, unregisterAsGenerator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.jgrapes.core.Manager

stream

Field Details

logger

protected final Logger logger

Constructor Details

Component

public Component()

Creates a new component base with its channel set to itself.

Component

public Component(Channel componentChannel)

Creates a new component base with its channel set to the given channel.

As a special case Channel.SELF can be passed to the constructor to make the component use itself as channel. The special value is necessary as you obviously cannot pass an object to be constructed to its constructor.

Parameters:

componentChannel - the channel that the component’s handlers listen on by default and that Manager.fire(Event, Channel...) sends the event to

Component

public Component(Channel componentChannel,
 HandlerDefinition.ChannelReplacements channelReplacements)

Creates a new component base like Component(Channel) but with channel mappings for Handler annotations.

Parameters:

componentChannel - the channel that the component’s handlers listen on by default and that Manager.fire(Event, Channel...) sends the event to

channelReplacements - the channel replacements to apply to the channels elements of the Handler annotations

Method Details

setName

public Component setName(String name)

Description copied from interface: Manager

Sets the (optional) name of the component.

Specified by:

setName in interface Manager

Overrides:

setName in class ComponentVertex

Parameters:

name - the name to set

Returns:

the component (for comfortable chaining)

component

public Component component()

Description copied from class: ComponentVertex

Returns the component represented by this node in the tree.

Specified by:

component in interface Manager

Specified by:

component in class ComponentVertex

Returns:

the component

channel

public Channel channel()

Returns the channel associated with the component.

Specified by:

channel in interface Manager

Returns:

the channel as assigned by the constructor.

See Also:

• Manager.channel()

defaultCriterion

public Object defaultCriterion()

Return the object itself as value.

Specified by:

defaultCriterion in interface Eligible

Returns:

the criterion

isEligibleFor

public boolean isEligibleFor(Object value)

Matches the object itself (using identity comparison) or the Channel class.

Specified by:

isEligibleFor in interface Channel

Specified by:

isEligibleFor in interface Eligible

Parameters:

value - the criterion

Returns:

true, if is eligible for

See Also:

• Channel.isEligibleFor(Object)