com.buschmais.xo.impl.plugin.PluginRepository Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xo.impl Show documentation

The newest version!

package com.buschmais.xo.impl.plugin;

/**
 * Interface for plugin repositories providing methods for registration,
 * unregistration and lookup.
 */
public interface PluginRepository {

    /**
     * Return the type of plugins managed by this repository.
     *
     * @return The type of plugins.
     */
    Class getPluginType();

    /**
     * Register a plugin.
     *
     * @param plugin
     *     The plugin instance.
     * @return The key used to identify the plugin.
     */
    Key register(Plugin plugin);

    /**
     * Register a plugin by its type.
     *
     * @param pluginType
     *     The plugin type.
     * @return The key used to identify the plugin.
     */
    Key register(Class pluginType);

    /**
     * Unregister a plugin.
     *
     * @param key
     *     The key.
     */
    void unregister(Key key);

    /**
     * Lookup a plugin.
     *
     * @param key
     *     The key.
     * @return The plugin.
     */
    Plugin get(Key key);
}