org.arquillian.spacelift.task

Interface TaskRegistry

public interface TaskRegistry

Registry that contains all available tasks.

Author:

Karel Piwko

Method Summary

Methods

Modifier and Type	Method and Description
<IN,OUT,TASK extends Task<? super IN,OUT>> TASK	find(Class<TASK> taskType) Finds task by its type.
Task<?,?>	find(String alias) Finds task by its alias.
<IN,OUT> Task<IN,OUT>	find(String alias, Class<IN> inType, Class<OUT> outType) Finds task by its alias.
<IN,OUT,TASK extends Task<? super IN,OUT>> TaskRegistry	register(Class<TASK> taskType, String... aliases) Registers NoArgConstructorTaskFactory for the task type.
<IN,OUT,TASK extends Task<? super IN,OUT>,TASK_FACTORY extends TaskFactory<IN,OUT,TASK>> TaskRegistry	register(Class<TASK> taskDef, TASK_FACTORY taskFactory) Registers task factory in the registry.
<IN,OUT,TASK extends Task<? super IN,OUT>,TASK_FACTORY extends TaskFactory<IN,OUT,TASK>> TaskRegistry	register(TASK_FACTORY taskFactory) Registers task factory in the registry.

Method Detail

register

<IN,OUT,TASK extends Task<? super IN,OUT>,TASK_FACTORY extends TaskFactory<IN,OUT,TASK>> TaskRegistry register(Class<TASK> taskDef,
                                                                                                             TASK_FACTORY taskFactory)
                      throws InvalidTaskException

Registers task factory in the registry.

Parameters:

taskDef - Task created by this factory

taskFactory - Task fac

Returns:

Throws:

InvalidTaskException

register

<IN,OUT,TASK extends Task<? super IN,OUT>,TASK_FACTORY extends TaskFactory<IN,OUT,TASK>> TaskRegistry register(TASK_FACTORY taskFactory)
                      throws InvalidTaskException

Registers task factory in the registry. Registered task cannot be instantiated by calling TaskFactory#find(Class) but can be instantiated by aliases provided by factory itself.

Parameters:

taskFactory -

Returns:

Throws:

InvalidTaskException

register

<IN,OUT,TASK extends Task<? super IN,OUT>> TaskRegistry register(Class<TASK> taskType,
                                                               String... aliases)
                      throws InvalidTaskException

Registers NoArgConstructorTaskFactory for the task type. Requires task to take no-arg constructor.

Parameters:

task -

aliases - Optional aliases for the task

Returns:

Throws:

InvalidTaskException

find

<IN,OUT,TASK extends Task<? super IN,OUT>> TASK find(Class<TASK> taskType)
                       throws InvalidTaskException

Finds task by its type.

Parameters:

toolType -

Returns:

Throws:

InvalidTaskException

find

Task<?,?> find(String alias)
               throws InvalidTaskException

Finds task by its alias. This method should be used only by metadata bindings.

Parameters:

alias - the alias

Returns:

Throws:

InvalidTaskException

find

<IN,OUT> Task<IN,OUT> find(String alias,
                         Class<IN> inType,
                         Class<OUT> outType)
                  throws InvalidTaskException

Finds task by its alias.

Parameters:

alias - the alias

inType - the input type of the task

outType - the output type of the task

Returns:

Throws:

InvalidTaskException - in case that task input/output type is different