com.github.bjoernpetersen.jmusicbot.PlatformPlugin Maven / Gradle / Ivy

Go to download

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

Core library of MusicBot, which plays music from various providers.

There is a newer version: 0.25.0

package com.github.bjoernpetersen.jmusicbot;

import com.github.bjoernpetersen.jmusicbot.platform.Platform;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * Serves as a loader for platform dependent plugins. Allows plugins to choose the implementation
 * class to load based on the current platform. This interface should not be directly implemented.
 */
public interface PlatformPlugin {

  @Nonnull
  String getReadableName();

  /**
   * Gets an instance of the represented plugin supporting the specified platform.
   *
   * @return an inactive plugin, or null if the platform is not supported
   */
  @Nullable
  T load(@Nonnull Platform platform);
}