org.cloudburstmc.server.plugin

Class CloudPluginDescription

java.lang.Object

org.cloudburstmc.server.plugin.CloudPluginDescription

All Implemented Interfaces:

PluginDescription

Direct Known Subclasses:

CloudPluginContainer, JavaPluginDescription

public class CloudPluginDescription
extends Object
implements PluginDescription

Constructor Summary

Constructors

Constructor and Description
CloudPluginDescription(PluginDescription description)
CloudPluginDescription(String id, String name, String version, Collection<String> authors, String description, Collection<PluginDependency> dependencies, String url, Path path, PluginLoader loader)

Method Summary

Modifier and Type	Method and Description
Collection<String>	getAuthors() The author of this plugin.
Collection<PluginDependency>	getDependencies() The array of plugin IDs that this plugin requires in order to function fully.
Optional<String>	getDescription()
String	getId() The ID for this plugin.
String	getName()
Optional<Path>	getPath() The path where the plugin is located on the file system.
PluginLoader	getPluginLoader()
Optional<String>	getUrl() Plugin's website specified in the plugin.yml.
String	getVersion() The version of this plugin.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CloudPluginDescription

public CloudPluginDescription(String id,
                              String name,
                              String version,
                              Collection<String> authors,
                              String description,
                              Collection<PluginDependency> dependencies,
                              String url,
                              Path path,
                              PluginLoader loader)

CloudPluginDescription

public CloudPluginDescription(@Nonnull
                              PluginDescription description)

Method Detail

getId

@Nonnull
public String getId()

Description copied from interface: PluginDescription

The ID for this plugin. This should be an alphanumeric name. Slashes are also allowed.

Specified by:

getId in interface PluginDescription

Returns:

the ID for this plugin

getName

@Nonnull
public String getName()

Specified by:

getName in interface PluginDescription

getDescription

@Nonnull
public Optional<String> getDescription()

Specified by:

getDescription in interface PluginDescription

getPath

@Nonnull
public Optional<Path> getPath()

Description copied from interface: PluginDescription

The path where the plugin is located on the file system.

Specified by:

getPath in interface PluginDescription

Returns:

the path of this plugin

getAuthors

@Nonnull
public Collection<String> getAuthors()

Description copied from interface: PluginDescription

The author of this plugin.

Specified by:

getAuthors in interface PluginDescription

Returns:

the plugin's author

getVersion

@Nonnull
public String getVersion()

Description copied from interface: PluginDescription

The version of this plugin.

Specified by:

getVersion in interface PluginDescription

Returns:

the version of this plugin

getDependencies

@Nonnull
public Collection<PluginDependency> getDependencies()

Description copied from interface: PluginDescription

The array of plugin IDs that this plugin requires in order to function fully.

Specified by:

getDependencies in interface PluginDescription

Returns:

the dependencies

getUrl

@Nonnull
public Optional<String> getUrl()

Description copied from interface: PluginDescription

Plugin's website specified in the plugin.yml.

Specified by:

getUrl in interface PluginDescription

Returns:

website url

getPluginLoader

@Nonnull
public PluginLoader getPluginLoader()

Specified by:

getPluginLoader in interface PluginDescription