cn.nukkit.plugin.service.ServiceManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of powernukkitx Show documentation

Make Nukkit great again!

There is a newer version: 1.20.40-r1

package cn.nukkit.plugin.service;

import cn.nukkit.plugin.Plugin;

import java.util.List;

/**
 * @since 16-11-20
 */
public interface ServiceManager {

    /**
     * Register an object as a service's provider.
     *
     * @param service  the service
     * @param provider the service provider
     * @param plugin   the plugin
     * @param priority the priority
     * @return {@code true}, or {@code false} only if {@code provider}
     * already registered
     */
     boolean register(Class service, T provider, Plugin plugin, ServicePriority priority);

    /**
     * Cancel service's provider(s) offered this plugin.
     *
     * @param plugin the plugin
     * @return a {@link com.google.common.collect.ImmutableList}
     * contains cancelled {@link RegisteredServiceProvider}
     */
    List> cancel(Plugin plugin);

    /**
     * Cancel a service's provider.
     *
     * @param service  the service
     * @param provider the provider
     * @return the cancelled {@link RegisteredServiceProvider}, or {@code null} if not
     * any provider cancelled
     */
     RegisteredServiceProvider cancel(Class service, T provider);

    /**
     * Return the service's provider.
     *
     * @param service the target service
     * @return a {@link RegisteredServiceProvider} registered highest priority, or
     * {@code null} if not exists
     */
     RegisteredServiceProvider getProvider(Class service);

    /**
     * Return the known service(s).
     *
     * @return a {@link com.google.common.collect.ImmutableList} contains the
     * known service(s)
     */
    List> getKnownService();

    List> getRegistrations(Plugin plugin);

     List> getRegistrations(Class service);

     boolean isProvidedFor(Class service);
}