• Home
• org.arquillian.spacelift
• arquillian-spacelift-api
• 1.0.1
• source code
• TaskRegistry.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.arquillian.spacelift.task.TaskRegistry Maven / Gradle / Ivy

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2014, Red Hat Middleware LLC, and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.arquillian.spacelift.task;

/**
 * Registry that contains all available tasks.
 *
 * @author Karel Piwko
 */
public interface TaskRegistry {

    /**
     * Registers task factory in the registry.
     *
     * @param taskDef
     *     Task created by this factory
     * @param taskFactory
     *     Task fac
     *
     * @throws InvalidTaskException
     */
    , TASK_FACTORY extends TaskFactory> TaskRegistry register(
        Class taskDef, TASK_FACTORY taskFactory) throws InvalidTaskException;

    /**
     * Registers task factory in the registry. Registered task cannot be instantiated by calling {@see
     * TaskFactory#find(Class)}
     * but can be instantiated by aliases provided by factory itself.
     *
     * @throws InvalidTaskException
     */
    , TASK_FACTORY extends TaskFactory> TaskRegistry register(
        TASK_FACTORY taskFactory) throws InvalidTaskException;

    /**
     * Registers {@link NoArgConstructorTaskFactory} for the task type. Requires task to take no-arg constructor.
     *
     * @param aliases
     *     Optional aliases for the task
     *
     * @throws InvalidTaskException
     */
    > TaskRegistry register(Class taskType, String... aliases)
        throws InvalidTaskException;

    /**
     * Finds task by its type.
     *
     * @throws InvalidTaskException
     */
    > TASK find(Class taskType) throws InvalidTaskException;

    /**
     * Finds task by its alias.
     * 

     * This method should be used only by metadata bindings.
     *
     * @param alias
     *     the alias
     */
    Task find(String alias) throws InvalidTaskException;

    /**
     * Finds task by its alias.
     *
     * @param alias
     *     the alias
     * @param inType
     *     the input type of the task
     * @param outType
     *     the output type of the task
     *
     * @throws InvalidTaskException
     *     in case that task input/output type is different
     */
     Task find(String alias, Class inType, Class outType) throws InvalidTaskException;
}