Package org.refcodes.jobbus

Class AbstractJobBusDirectory<CTX,H>

java.lang.Object

org.refcodes.jobbus.AbstractJobBus<CTX,H>

org.refcodes.jobbus.AbstractJobBusDirectory<CTX,H>

Type Parameters:

CTX - The context type to use, can by any Component, service or POJO.

H - The handle type used to reference a job.

All Implemented Interfaces:

org.refcodes.component.FlushHandle<CTX>, org.refcodes.component.HandleDirectory<CTX,H>, org.refcodes.component.HandleLookup<CTX,H>, org.refcodes.component.ProgressHandle<CTX>, org.refcodes.component.ResetHandle<CTX>, JobBus<CTX,H>, JobBusDirectory<CTX,H>

Direct Known Subclasses:

JobBusDirectoryImpl

public abstract class AbstractJobBusDirectory<CTX,H>
extends AbstractJobBus<CTX,H>
implements JobBusDirectory<CTX,H>

The AbstractJobBusDirectory extends the AbstractJobBus with the JobBusDirectory functionality.

Constructor Summary

Constructors

Constructor	Description
AbstractJobBusDirectory(CTX aContext, org.refcodes.component.HandleGenerator<H> aHandleGenerator)	Instantiates the AbstractJobBusDirectory with the provided context and the provided HandleGenerator.

Method Summary

Modifier and Type	Method	Description
Collection<org.refcodes.command.Undoable<CTX,?,?>>	handleReferences()	Handle references.
Set<H>	handles()	Returns the set of handles managed by this implementation.

Methods inherited from class org.refcodes.jobbus.AbstractJobBus

execute, execute, execute, flush, getException, getJob, getProgress, getResult, getResult, getResult, hasException, hasFlush, hasHandle, hasProgress, hasReset, hasResult, isExecuted, lookupHandle, removeHandle, reset, waitForExecution, waitForExecution

Methods inherited from interface org.refcodes.component.FlushHandle

flush, flushUnchecked, hasFlush

Methods inherited from interface org.refcodes.component.HandleLookup

hasHandle, lookupHandle, removeHandle

Methods inherited from interface org.refcodes.jobbus.JobBus

execute, execute, execute, getException, getResult, getResult, getResult, hasException, hasResult, isExecuted, waitForExecution, waitForExecution

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.component.ProgressHandle

getProgress, hasProgress

Methods inherited from interface org.refcodes.component.ResetHandle

hasReset, reset

Constructor Detail

AbstractJobBusDirectory

public AbstractJobBusDirectory(CTX aContext,
                               org.refcodes.component.HandleGenerator<H> aHandleGenerator)

Instantiates the AbstractJobBusDirectory with the provided context and the provided HandleGenerator. It is up to you which context (service, Component, POJO) you want to provide to a job (Undoable) when being executed. Also you can provide any HandleGenerator you thing useful when creating handles. It is up to your HandleGenerator to generate unique handle objects. The JobBusDirectory actually uses a String objects generating HandleGenerator. Make sure your handles implement the Object.hashCode() and Object.equals(Object) methods as of their method contracts as them handles will be used in collections such as HashMap data structures.

Parameters:

aContext - The context which is passed to the job (Undoable) instances when being executed.

aHandleGenerator - The HandleGenerator to be used when generating unique handle objects.

Method Detail

handleReferences

public Collection<org.refcodes.command.Undoable<CTX,?,?>> handleReferences()

Handle references.

Specified by:

handleReferences in interface org.refcodes.component.HandleDirectory<CTX,H>

Overrides:

handleReferences in class AbstractJobBus<CTX,H>

Returns:

the collection

handles

public Set<H> handles()

Returns the set of handles managed by this implementation.

Specified by:

handles in interface org.refcodes.component.HandleDirectory<CTX,H>

Overrides:

handles in class AbstractJobBus<CTX,H>

Returns:

The set containing all currently managed handles.