Module org.refcodes.component
Package org.refcodes.component
package org.refcodes.component
-
ClassDescriptionAbstractComponentComposite<C extends Component>The
AbstractComponentComposite
is an implementation of theComponentComposite
.TheAbstractComponentComposite.ExtendedCompositeComponentImpl
is an implementation of theComponentComposite.ExtendedComponentComposite
.TheAbstractConnectableAutomaton
implements the very basicAbstractConnectableAutomaton
functionality.TheAbstractDeviceAutomaton
implements the very basicAbstractDeviceAutomaton
functionality.BidirectionalConnectionAccessor<INPUT,OUTPUT> Provides an accessor for a connection property for e.g. anInputStream
or anOutputStream
.Provides a mutator for a connection property for e.g. anInputStream
or anOutputStream
.Provides a connection property for e.g. anInputStream
or anOutputStream
.BidirectionalConnectionComponent<INPUT,OUTPUT> A component implementing theBidirectionalConnectionComponent
interface supports a connection.A system implementing theBidirectionalConnectionComponent.BidirectionalConnectionAutomaton
interface supports managingBidirectionalConnectionComponent
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.BidirectionalConnectionOpenable<INPUT,OUTPUT> This mixin might be implemented by a component in order to provide opening connection(s) facilities.TheBidirectionalConnectionOpenable.BidirectionalConnectionOpenAutomaton
interface defines those methods related to the opening of connection(s) life-cycle.BidirectionalConnectionOpenableHandle<H,INPUT, OUTPUT> TheBidirectionalConnectionOpenableHandle
interface defines those methods related to the handle based open/connect life-cycle.TheBidirectionalConnectionOpenableHandle.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.TheCeasable.CeaseAutomaton
interface defines those methods related to the cease life-cycle.Ceasable.CeaseBuilder<B extends Ceasable.CeaseBuilder<B>>To enable theCeasable
functionality to be invoked in a builder chain.SeeCeasable
without any checked exception being declared.TheCeasableHandle
interface defines those methods related to the handle based cease life-cycle.TheCeasableHandle.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 theCeaseException
.This mixin might be implemented by a component in order to provide closing connection(s) facilities.TheClosable.CloseAutomaton
interface defines those methods related to the closing of connection(s) life-cycle.Closable.CloseBuilder<B extends Closable.CloseBuilder<B>>To enable theClosable
functionality to be invoked in a builder chain.TheClosableHandle
interface defines those methods related to the handle based close life-cycle.TheClosableHandle.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 theCloseException
.Per definition anyComponent
at least must provide aDestroyable.destroy()
method.Any composite implementation of the refcodes frameworks should implement thisComponentComposite
interface so that any therein containedComponent
instances' state change methods are supported by theComponentComposite
as well and forwarded to theComponent
contained in theComponentComposite
instance.TheComponentComposite.ExtendedComponentComposite
provides extended functionality to theComponentComposite
's functionality by including extendedOpenable
functionality (ConnectionOpenable
) and extendsInitializable
functionality (Configurable
).This exception is the base exception for the component package.ComponentHandleComposite<H,REF> Similar to theComponentComposite
, theComponentHandleComposite
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.Configurable<CTX>This mixin might be implemented by a component in order to provide initialize facilities wit a configuration provided viaConfigurable.initialize(Object)
.TheConfigurable.ConfigureAutomaton
interface defines those methods related to the initialize life-cycle with a provided context.Configurable.ConfigureBuilder<CTX,B extends Configurable.ConfigureBuilder<CTX, B>> To enable theInitializable
functionality to be invoked in a builder chain.AConfigurableComponent
can be configured invoking the methodConfigurable.initialize(Object)
.ConfigurableHandle<H,CTX> TheConfigurableHandle
interface defines those methods related to the handle based initialize/configure life-cycle.TheConfigurableHandle.ConfigureAutomatonHandle
interface defines those methods related to the handle based initialize/configure life-cycle.This class implements aConfigurableLifecycleComponent.ConfigurableLifecycleAutomaton
.A component implementing theConfigurableLifecycleComponent
interface supports a life-cycle.A system implementing theConfigurableLifecycleComponent.ConfigurableLifecycleAutomaton
interface supports managingConfigurableLifecycleComponent
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.TheConfigurableLifecycleComponentHandle
manages variousLifecycleStatus
states forConfigurableLifecycleComponent
instances each related to a handle.TheConfigurableLifecycleComponentHandle.ConfigurableLifecycleAutomatonHandle
is an automaton managing variousLifecycleStatus
states forComponent
instances each related to a handle.Thrown in case initializing a component caused problems.Thrown in case initializing a component caused problems.AnyComponent
which operates established connections may implement theConnectableComponent
interface providing a minimal set of functionality to work with connections; to test whether a connection is open and to close an open connection.TheConnectableComponent.ConnectableAutomaton
extends theConnectableComponent
with automaton functionality to get detailed status information regarding connections.ConnectionAccessor<CON>Provides an accessor for a connection property for e.g. anInputStream
or anOutputStream
.Provides a mutator for a connection property for e.g. anInputStream
or anOutputStream
.Provides a connection property for e.g. anInputStream
or anOutputStream
.This class implements aConnectionComponent.ConnectionAutomaton
.ConnectionComponent<CON>A component implementing theConnectionComponent
interface supports a connection.A system implementing theConnectionComponent.ConnectionAutomaton
interface supports managingConnectionComponent
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 theConnectionComponent
with additional according builder methods.ConnectionComponentHandle<H,CON> TheConnectionComponentHandle
manages variousConnectionStatus
states forConnectionComponent
instances each related to a handle.TheConnectionComponentHandle.ConnectionAutomatonHandle
is an automaton managing variousConnectionStatus
states forConnectionComponent
instances each related to a handle.ConnectionOpenable<CON>This mixin might be implemented by a component in order to provide opening connection(s) facilities.TheConnectionOpenable.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 theStartable
functionality to be invoked in a builder chain.ConnectionOpenableHandle<H,CON> TheConnectionOpenableHandle
interface defines those methods related to the handle based open/connect life-cycle.TheConnectionOpenableHandle.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 aConnectionStatus
property.Provides a mutator for aConnectionStatus
property.Provides aConnectionStatus
property.The Interface ConnectionStatusHandle.ContextAccessor<CTX>Provides an accessor for a context property for e.g. a service or a component.ContextAccessor.ContextBuilder<CTX,B extends ContextAccessor.ContextBuilder<CTX, B>> 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.TheDecomposeable.DecomposeAutomaton
interface defines those methods related to the decompose life-cycle.TheDecomposeableHandle
interface defines those methods related to the handle based decompose life-cycle.TheDecomposeableHandle.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 theDecomposeException
.This mixin might be implemented by aComponent
in order to provide destroy facilities.TheDestroyable.DestroyAutomaton
interface defines those methods related to the destroy life-cycle.TheDestroyableHandle
interface defines those methods related to the handle based destroy life-cycle.TheDestroyableHandle.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 theDestroyException
.Digester<J>ADigester
provides the functionality to consume a job (which is pushed from the outside) for further processing.Thrown in case digesting (processing) a job by aDigester.digest(Object)
caused problems; the cause is usually wrapped by thisException
.Thrown in case digesting (processing) a job by aDigester.digest(Object)
caused problems; the cause is usually wrapped by thisException
.Thrown in case disposing a component caused problems.Unchecked exception with the same semantics as theDisposeException
.This mixin might be implemented by a component in order to provide flush facilities.Flushable.FlushBuilder<B extends Flushable.FlushBuilder<B>>The Interface FlushBuilder.FlushHandle<H>TheFlushHandle
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.HandleDirectory<H,REF> The handle directory enables listing of all known data managed by the implementing component.Generates handles of the generic type.Plain straight forwardString
instances generatingHandleGenerator
basically being a plain good oldUniqueIdGenerator
.HandleLookup<H,REF> 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.TheInitializable.InitializeAutomaton
interface defines those methods related to the initialize life-cycle.To enable theInitializable
functionality to be invoked in a builder chain.SeeInitializable
without any checked exception being declared.AInitializableComponent
can be initialized invoking the methodInitializable.initialize()
.TheInitializableHandle
interface defines those methods related to the handle based initialize life-cycle.TheInitializableHandle.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 theIOException
.This class implements aLifecycleComponent.LifecycleAutomaton
.Opens the otherwise protectedLifecycleAutomatonImpl.ManualLifecycleAutomatonImpl.setLifecycleStatus(LifecycleStatus)
to be public in order to force any lifecycle status to be set.A component implementing theLifecycleComponent
interface supports a life-cycle.A system implementing theLifecycleComponent.LifecycleAutomaton
interface supports managingLifecycleComponent
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 theLifecycleComponent
though without the need to try-catch any exceptions on the various life-cycle stages.TheLifecycleComponentHandle
manages variousLifecycleStatus
states forLifecycleComponent
instances each related to a handle.TheLifecycleComponentHandle.LifecycleAutomatonHandle
is an automaton managing variousLifecycleStatus
states forComponent
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 aLifecycleRequest
property.Provides a mutator for aLifecycleRequest
property.Provides aLifecycleRequest
property.The Enum LifecycleStatus.Provides an accessor for aLifecycleStatus
property.LifecycleStatusAccessor.LifecycleStatusBuilder<B extends LifecycleStatusAccessor.LifecycleStatusBuilder<B>>Provides a builder method for aLifecycleStatus
property returning the builder for applying multiple build operations.Provides a mutator for aLifecycleStatus
property.Provides aLifecycleStatus
property.The Interface LifecycleStatusHandle.This class implements aLifecycleComponent.LifecycleAutomaton
.A component implementing theLinkComponent
interface supports establishing a connection (not necessarily a network connection).A system implementing theLinkComponent.LinkAutomaton
interface supports managingLinkComponent
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 theLinkComponent
with additional according builder methods.TheLinkComponentHandle
manages variousConnectionStatus
states forLinkComponent
instances each related to a handle.TheLinkComponentHandle.LinkAutomatonHandle
is an automaton managing variousConnectionStatus
states forComponent
instances each related to a handle.This mixin might be implemented by a component in order to provide opening connection(s) facilities.TheOpenable.OpenAutomaton
interface defines those methods related to the opening of connection(s) life-cycle.Openable.OpenBuilder<B extends Openable.OpenBuilder<B>>To enable theStartable
functionality to be invoked in a builder chain.TheOpenableHandle
interface defines those methods related to the handle based open/connect life-cycle.TheOpenableHandle.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.OpenedHandle<H>Provides access to the opened (connected) handle reference.This mixin might be implemented by a component in order to provide pause facilities.ThePausable.PauseAutomaton
interface defines those methods related to the pause life-cycle.Pausable.PauseBuilder<B extends Pausable.PauseBuilder<B>>To enable thePausable
functionality to be invoked in a builder chain.SeePausable
without any checked exception being declared.ThePausableHandle
interface defines those methods related to the handle based pause life-cycle.ThePausableHandle.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 thePauseException
.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.Reloadable.ReloadBuilder<B extends Reloadable.ReloadBuilder<B>>The Interface ReloadBuilder.ReloadHandle<H>TheReloadHandle
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 theResetException
.ResetHandle<H>TheResetHandle
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.TheResumable.ResumeAutomaton
interface defines those methods related to the resume life-cycle.Resumable.ResumeBuilder<B extends Resumable.ResumeBuilder<B>>To enable theResumable
functionality to be invoked in a builder chain.SeeResumable
without any checked exception being declared.TheResumableHandle
interface defines those methods related to the handle based resume life-cycle.TheResumableHandle.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 theResumeException
.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.TheStartable.StartAutomaton
interface defines those methods related to the start life-cycle.Startable.StartBuilder<B extends Startable.StartBuilder<B>>To enable theStartable
functionality to be invoked in a builder chain.SeeStartable
without any checked exception being declared.TheStartableHandle
interface defines those methods related to the handle based start life-cycle.TheStartableHandle.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 theStartException
.Thrown in case stopping a component caused problems.Unchecked exception with the same semantics as theStopException
.This mixin might be implemented by a component in order to provide stop facilities.TheStoppable.StopAutomaton
interface defines those methods related to the stop life-cycle.Stoppable.StopBuilder<B extends Stoppable.StopBuilder<B>>To enable theStoppable
functionality to be invoked in a builder chain.SeeStoppable
without any checked exception being declared.TheStoppableHandle
interface defines those methods related to the handle based stop life-cycle.TheStoppableHandle.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.