ru.yandex.qatools.allure.plugins.PluginsIndex Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of allure-report-plugin-api Show documentation

There is a newer version: 1.5.4

Show newest version

package ru.yandex.qatools.allure.plugins;

import java.util.List;

/**
 * You can use this index to find loaded plugins.
 *
 * @author Dmitry Baev [email protected]
 *         Date: 10.07.15
 */
public interface PluginsIndex {

    /**
     * Find the plugin by given type. If there is few
     * plugins with given type returns the some of them.
     *
     * @param type the given type of plugin to find.
     * @param   the plugin type to find.
     * @return any loaded plugin with given type or null if
     * there is no such plugin.
     */
     T find(Class type);

    /**
     * Find all the plugins with type.
     *
     * @param type the given type of plugin to find.
     * @param   the plugin type to find.
     * @return all loaded plugins with given type or null if
     * there is no such plugins.
     */
     List findAll(Class type);

    /**
     * Find plugin by name. See {@link Plugin.Name}
     * Returns null if there is no such plugin.
     *
     * @param name the given name of plugin to find.
     * @return found plugin with given name or null if there is no such plugin.
     */
    Plugin find(String name);

    /**
     * Get all loaded plugins.
     *
     * @return the list of loaded plguins.
     */
    List getPlugins();

}