All Classes and Interfaces
Class
Description
The
AbstractComponentComposite
is an implementation of the
ComponentComposite
.The
AbstractComponentComposite.ExtendedCompositeComponentImpl
is an implementation of the
ComponentComposite.ExtendedComponentComposite
.The
AbstractConnectableAutomaton
implements the very basic
AbstractConnectableAutomaton
functionality.The
AbstractDeviceAutomaton
implements the very basic
AbstractDeviceAutomaton
functionality.Provides an accessor for a connection property for e.g. an
InputStream
or an OutputStream
.Provides a mutator for a connection property for e.g. an
InputStream
or an OutputStream
.Provides a connection property for e.g. an
InputStream
or an
OutputStream
.A component implementing the
BidirectionalConnectionComponent
interface supports a connection.A system implementing the
BidirectionalConnectionComponent.BidirectionalConnectionAutomaton
interface supports managing BidirectionalConnectionComponent
instances and takes care that the open/close statuses are invoked in the
correct order by throwing according exceptions in case the
open/close-cycle is invoked in the wrong order.This mixin might be implemented by a component in order to provide opening
connection(s) facilities.
The
BidirectionalConnectionOpenable.BidirectionalConnectionOpenAutomaton
interface defines those
methods related to the opening of connection(s) life-cycle.The
BidirectionalConnectionOpenableHandle
interface defines those
methods related to the handle based open/connect life-cycle.The
BidirectionalConnectionOpenableHandle.BidirectionalConnectionOpenAutomatonHandle
interface defines
those methods related to the handle based open/connect life-cycle.This mixin might be implemented by a component in order to provide cease
facilities.
The
Ceasable.CeaseAutomaton
interface defines those methods related to the
cease life-cycle.To enable the
Ceasable
functionality to be invoked in a builder
chain.See
Ceasable
without any checked exception being declared.The
CeasableHandle
interface defines those methods related to the
handle based cease life-cycle.The
CeasableHandle.CeaseAutomatonHandle
interface defines those methods related
to the handle based cease life-cycle.Thrown in case ceasing a component caused problems.
Unchecked exception with the same semantics as the
CeaseException
.This mixin might be implemented by a component in order to provide closing
connection(s) facilities.
The
Closable.CloseAutomaton
interface defines those methods related to the
closing of connection(s) life-cycle.To enable the
Closable
functionality to be invoked in a builder
chain.The
ClosableHandle
interface defines those methods related to the
handle based close life-cycle.The
ClosableHandle.CloseAutomatonHandle
interface defines those methods related
to the handle based close life-cycle.Provides an accessor for a closed property.
Provides a mutator for a closed property.
Provides a closed property.
Thrown in case closing a component caused problems.
Unchecked exception with the same semantics as the
CloseException
.Per definition any
Component
at least must provide a
Destroyable.destroy()
method.Any composite implementation of the refcodes frameworks should implement this
ComponentComposite
interface so that any therein contained
Component
instances' state change methods are supported by the
ComponentComposite
as well and forwarded to the Component
contained in the ComponentComposite
instance.The
ComponentComposite.ExtendedComponentComposite
provides extended functionality to
the ComponentComposite
's functionality by including extended
Openable
functionality (ConnectionOpenable
) and extends
Initializable
functionality (Configurable
).This exception is the base exception for the component package.
Similar to the
ComponentComposite
, the
ComponentHandleComposite
provides all the defined handle based
functionality, implementing classes provide the means to invoke those methods
in case them are supported by the referenced components.This exception is the base runtime exception for the component package.
The Class ComponentUtility.
This mixin might be implemented by a component in order to provide initialize
facilities wit a configuration provided via
Configurable.initialize(Object)
.The
Configurable.ConfigureAutomaton
interface defines those methods related to
the initialize life-cycle with a provided context.To enable the
Initializable
functionality to be invoked in a
builder chain.A
ConfigurableComponent
can be configured invoking the method
Configurable.initialize(Object)
.The
ConfigurableHandle
interface defines those methods related to the
handle based initialize/configure life-cycle.The
ConfigurableHandle.ConfigureAutomatonHandle
interface defines those methods
related to the handle based initialize/configure life-cycle.This class implements a
ConfigurableLifecycleComponent.ConfigurableLifecycleAutomaton
.A component implementing the
ConfigurableLifecycleComponent
interface
supports a life-cycle.A system implementing the
ConfigurableLifecycleComponent.ConfigurableLifecycleAutomaton
interface supports managing ConfigurableLifecycleComponent
instances and takes care that the open/close statuses are invoked in the
correct order by throwing according exceptions in case the
open/close-cycle is invoked in the wrong order.The
ConfigurableLifecycleComponentHandle
manages various
LifecycleStatus
states for ConfigurableLifecycleComponent
instances each related to a handle.The
ConfigurableLifecycleComponentHandle.ConfigurableLifecycleAutomatonHandle
is an automaton managing
various LifecycleStatus
states for Component
instances
each related to a handle.Thrown in case initializing a component caused problems.
Thrown in case initializing a component caused problems.
Any
Component
which operates established connections may implement
the ConnectableComponent
interface providing a minimal set of
functionality to work with connections; to test whether a connection is open
and to close an open connection.The
ConnectableComponent.ConnectableAutomaton
extends the ConnectableComponent
with automaton functionality to get detailed status information regarding
connections.Provides an accessor for a connection property for e.g. an
InputStream
or an OutputStream
.Provides a mutator for a connection property for e.g. an
InputStream
or an OutputStream
.Provides a connection property for e.g. an
InputStream
or an
OutputStream
.This class implements a
ConnectionComponent.ConnectionAutomaton
.A component implementing the
ConnectionComponent
interface supports a
connection.A system implementing the
ConnectionComponent.ConnectionAutomaton
interface supports
managing ConnectionComponent
instances and takes care that the
open/close statuses are invoked in the correct order by throwing
according exceptions in case the open/close-cycle is invoked in the wrong
order.ConnectionComponent.ConnectionComponentBuilder<CON,B extends ConnectionComponent.ConnectionComponentBuilder<CON,B>>
Similar to the
ConnectionComponent
with additional according
builder methods.The
ConnectionComponentHandle
manages various
ConnectionStatus
states for ConnectionComponent
instances
each related to a handle.The
ConnectionComponentHandle.ConnectionAutomatonHandle
is an automaton managing various
ConnectionStatus
states for ConnectionComponent
instances
each related to a handle.This mixin might be implemented by a component in order to provide opening
connection(s) facilities.
The
ConnectionOpenable.ConnectionOpenAutomaton
interface defines those methods
related to the opening of connection(s) life-cycle.ConnectionOpenable.ConnectionOpenBuilder<CON,B extends ConnectionOpenable.ConnectionOpenBuilder<CON,B>>
To enable the
Startable
functionality to be invoked in a builder
chain.The
ConnectionOpenableHandle
interface defines those methods related
to the handle based open/connect life-cycle.The
ConnectionOpenableHandle.ConnectionOpenAutomatonHandle
interface defines those methods
related to the handle based open/connect life-cycle.An enumeration describing the connection requests.
The Enum ConnectionStatus.
Provides an accessor for a
ConnectionStatus
property.Provides a mutator for a
ConnectionStatus
property.Provides a
ConnectionStatus
property.The Interface ConnectionStatusHandle.
Provides an accessor for a context property for e.g. a service or a
component.
Provides a builder method for a context property returning the builder
for applying multiple build operations.
Provides a mutator for a context property for e.g. a service or a
component.
Provides a context property for e.g. a service or a component.
This mixin might be implemented by a component in order to provide
decomposition facilities.
The
Decomposeable.DecomposeAutomaton
interface defines those methods related to
the decompose life-cycle.The
DecomposeableHandle
interface defines those methods related to
the handle based decompose life-cycle.The
DecomposeableHandle.DecomposeAutomatonHandle
interface defines those methods
related to the handle based decompose life-cycle.Thrown in case decomposing a component caused problems.
Unchecked exception with the same semantics as the
DecomposeException
.This mixin might be implemented by a
Component
in order to provide
destroy facilities.The
Destroyable.DestroyAutomaton
interface defines those methods related to
the destroy life-cycle.The
DestroyableHandle
interface defines those methods related to the
handle based destroy life-cycle.The
DestroyableHandle.DestroyAutomatonHandle
interface defines those methods
related to the handle based destroy life-cycle.Thrown in case stopping a component caused problems.
Unchecked exception with the same semantics as the
DestroyException
.A
Digester
provides the functionality to consume a job (which is
pushed from the outside) for further processing.Thrown in case digesting (processing) a job by a
Digester.digest(Object)
caused problems; the cause is usually wrapped
by this Exception
.Thrown in case digesting (processing) a job by a
Digester.digest(Object)
caused problems; the cause is usually
wrapped by this Exception
.Thrown in case disposing a component caused problems.
Unchecked exception with the same semantics as the
DisposeException
.This mixin might be implemented by a component in order to provide flush
facilities.
The Interface FlushBuilder.
The
FlushHandle
interface defines those methods related to the handle
based flush operation.Provides an accessor for a handle property for e.g. key / handle pair.
Provides a mutator for a handle property for e.g. key / handle pair.
Provides a handle property for e.g. key / handle pair.
The handle directory enables listing of all known data managed by the
implementing component.
Generates handles of the generic type.
Plain straight forward
String
instances generating
HandleGenerator
basically being a plain good old
UniqueIdGenerator
.Any system in this framework being able to work with handles provides an
implementation of the handle lookup interface.
This exception is thrown in case a handle was provided which was unknown to
the invoked component.
This exception is thrown in case a handle was provided whose reference does
not support a given operation.
This mixin might be implemented by a component in order to provide
initializing facilities.
The
Initializable.InitializeAutomaton
interface defines those methods related
to the initialize life-cycle.To enable the
Initializable
functionality to be invoked in a
builder chain.See
Initializable
without any checked exception being declared.A
InitializableComponent
can be initialized invoking the method
Initializable.initialize()
.The
InitializableHandle
interface defines those methods related to
the handle based initialize life-cycle.The
InitializableHandle.InitializeAutomatonHandle
interface defines those methods
related to the handle based initialize life-cycle.Provides an accessor for a initialized property.
Provides a mutator for a initialized property.
Provides a initialized property.
Provides access to the initialized handle reference.
Thrown in case initializing a component caused problems.
Unchecked exception with the same semantics as the
IOException
.This class implements a
LifecycleComponent.LifecycleAutomaton
.Opens the otherwise protected
LifecycleAutomatonImpl.ManualLifecycleAutomatonImpl.setLifecycleStatus(LifecycleStatus)
to be public in order to
force any lifecycle status to be set.A component implementing the
LifecycleComponent
interface supports a
life-cycle.A system implementing the
LifecycleComponent.LifecycleAutomaton
interface supports
managing LifecycleComponent
instances and takes care that the
life-cycle stages are invoked in the correct order by throwing according
exceptions in case the life-cycle is invoked in the wrong order.Same as the
LifecycleComponent
though without the need to
try-catch any exceptions on the various life-cycle stages.The
LifecycleComponentHandle
manages various LifecycleStatus
states for LifecycleComponent
instances each related to a handle.The
LifecycleComponentHandle.LifecycleAutomatonHandle
is an automaton managing various
LifecycleStatus
states for Component
instances each
related to a handle.This exception is the base lifecycle exception .
This exception is the base lifecycle exception .
An enumeration describing the lifecycle requests regarding a component..
Provides an accessor for a
LifecycleRequest
property.Provides a mutator for a
LifecycleRequest
property.Provides a
LifecycleRequest
property.The Enum LifecycleStatus.
Provides an accessor for a
LifecycleStatus
property.LifecycleStatusAccessor.LifecycleStatusBuilder<B extends LifecycleStatusAccessor.LifecycleStatusBuilder<B>>
Provides a builder method for a
LifecycleStatus
property
returning the builder for applying multiple build operations.Provides a mutator for a
LifecycleStatus
property.Provides a
LifecycleStatus
property.The Interface LifecycleStatusHandle.
This class implements a
LifecycleComponent.LifecycleAutomaton
.A component implementing the
LinkComponent
interface supports
establishing a connection (not necessarily a network connection).A system implementing the
LinkComponent.LinkAutomaton
interface supports
managing LinkComponent
instances and takes care that the
open/close statuses are invoked in the correct order by throwing
according exceptions in case the open/close-cycle is invoked in the wrong
order.Similar to the
LinkComponent
with additional according builder
methods.The
LinkComponentHandle
manages various ConnectionStatus
states for LinkComponent
instances each related to a handle.The
LinkComponentHandle.LinkAutomatonHandle
is an automaton managing various
ConnectionStatus
states for Component
instances each
related to a handle.This mixin might be implemented by a component in order to provide opening
connection(s) facilities.
The
Openable.OpenAutomaton
interface defines those methods related to the
opening of connection(s) life-cycle.To enable the
Startable
functionality to be invoked in a builder
chain.The
OpenableHandle
interface defines those methods related to the
handle based open/connect life-cycle.The
OpenableHandle.OpenAutomatonHandle
interface defines those methods related
to the handle based open/connect life-cycle.Provides an accessor for a opened property.
Provides a mutator for a opened property.
Provides a opened property.
Provides access to the opened (connected) handle reference.
This mixin might be implemented by a component in order to provide pause
facilities.
The
Pausable.PauseAutomaton
interface defines those methods related to the
pause life-cycle.To enable the
Pausable
functionality to be invoked in a builder
chain.See
Pausable
without any checked exception being declared.The
PausableHandle
interface defines those methods related to the
handle based pause life-cycle.The
PausableHandle.PauseAutomatonHandle
interface defines those methods related
to the handle based pause life-cycle.Thrown in case pausing a component caused problems.
Unchecked exception with the same semantics as the
PauseException
.Provides an accessor for a progress property.
Provides a mutator for a progress property.
Provides a progress property.
Whenever a handle is associated with a progress, then a component providing
such handles should implement this interface.
This mixin might be implemented by a component in order to provide reload
facilities.
The Interface ReloadBuilder.
The
ReloadHandle
interface defines those methods related to the
handle based reload operation.Thrown in case resetting a component caused problems.
Unchecked exception with the same semantics as the
ResetException
.The
ResetHandle
interface defines those methods related to the handle
based reset operation.This mixin might be implemented by a component in order to provide resume
facilities.
The
Resumable.ResumeAutomaton
interface defines those methods related to
the resume life-cycle.To enable the
Resumable
functionality to be invoked in a builder
chain.See
Resumable
without any checked exception being declared.The
ResumableHandle
interface defines those methods related to the
handle based resume life-cycle.The
ResumableHandle.ResumeAutomatonHandle
interface defines those methods related
to the handle based resume life-cycle.Thrown in case resuming a component caused problems.
Unchecked exception with the same semantics as the
ResumeException
.Provides an accessor for a running property.
Provides a mutator for a running property.
Provides a running property.
Provides access to the running handle reference.
This mixin might be implemented by a component in order to provide start
facilities.
The
Startable.StartAutomaton
interface defines those methods related to the
start life-cycle.To enable the
Startable
functionality to be invoked in a builder
chain.See
Startable
without any checked exception being declared.The
StartableHandle
interface defines those methods related to the
handle based start life-cycle.The
StartableHandle.StartAutomatonHandle
interface defines those methods related
to the handle based start life-cycle.Thrown in case starting a component caused problems.
Unchecked exception with the same semantics as the
StartException
.Thrown in case stopping a component caused problems.
Unchecked exception with the same semantics as the
StopException
.This mixin might be implemented by a component in order to provide stop
facilities.
The
Stoppable.StopAutomaton
interface defines those methods related to the
stop life-cycle.To enable the
Stoppable
functionality to be invoked in a builder
chain.See
Stoppable
without any checked exception being declared.The
StoppableHandle
interface defines those methods related to the
handle based stop life-cycle.The
StoppableHandle.StopAutomatonHandle
interface defines those methods related
to the handle based stop life-cycle.This exception is thrown in case a handle was provided which was unknown to
the invoked component.
This exception is thrown in case a handle was provided whose reference does
not support a given operation.