org.spongepowered.api.plugin

Interface PluginContainer

public interface PluginContainer

A wrapper around a class marked with an Plugin annotation to retrieve information from the annotation for easier use.

Method Summary

Modifier and Type	Method and Description
default Optional<Asset>	getAsset(String name) Retrieves the Asset of the specified name from the AssetManager for this Plugin.
default List<String>	getAuthors() Gets the authors of the Plugin within this container.
default Set<org.spongepowered.plugin.meta.PluginDependency>	getDependencies() Gets a Set of all dependencies of the Plugin within this container.
default Optional<org.spongepowered.plugin.meta.PluginDependency>	getDependency(String id) Gets the PluginDependency the plugin in this container has on the plugin with the specified plugin ID.
default Optional<String>	getDescription() Gets the description of the Plugin within this container.
String	getId() Gets the qualified ID of the Plugin within this container.
default Optional<?>	getInstance() Returns the created instance of Plugin if it is available.
default org.slf4j.Logger	getLogger() Returns the assigned logger to this Plugin.
default String	getName() Gets the name of the Plugin within this container.
default Optional<Path>	getSource() Returns the source the plugin was loaded from.
default Optional<String>	getUrl() Gets the url or website of the Plugin within this container.
default Optional<String>	getVersion() Gets the version of the Plugin within this container.

Method Detail

getId

String getId()

Gets the qualified ID of the Plugin within this container.

Returns:

The plugin ID

See Also:

Plugin.id()

getName

default String getName()

Gets the name of the Plugin within this container.

Returns:

The plugin name, or getId() if unknown

See Also:

Plugin.name()

getVersion

default Optional<String> getVersion()

Gets the version of the Plugin within this container.

Returns:

The plugin version, or Optional.empty() if unknown

See Also:

Plugin.version()

getDescription

default Optional<String> getDescription()

Gets the description of the Plugin within this container.

Returns:

The plugin description, or Optional.empty() if unknown

See Also:

Plugin.description()

getUrl

default Optional<String> getUrl()

Gets the url or website of the Plugin within this container.

Returns:

The plugin url, or Optional.empty() if unknown

See Also:

Plugin.url()

getAuthors

default List<String> getAuthors()

Gets the authors of the Plugin within this container.

Returns:

The plugin authors, or empty if unknown

See Also:

Plugin.authors()

getDependencies

default Set<org.spongepowered.plugin.meta.PluginDependency> getDependencies()

Gets a Set of all dependencies of the Plugin within this container.

Returns:

The plugin dependencies, can be empty

See Also:

Plugin.dependencies()

getDependency

default Optional<org.spongepowered.plugin.meta.PluginDependency> getDependency(String id)

Gets the PluginDependency the plugin in this container has on the plugin with the specified plugin ID.

Parameters:

id - The plugin ID of the dependency

Returns:

The dependency, or Optional.empty() if unknown

getAsset

default Optional<Asset> getAsset(String name)

Retrieves the Asset of the specified name from the AssetManager for this Plugin.

Parameters:

name - Name of asset

Returns:

Asset if present, empty otherwise

getSource

default Optional<Path> getSource()

Returns the source the plugin was loaded from.

Returns:

The source the plugin was loaded from or Optional.empty() if unknown

getInstance

default Optional<?> getInstance()

Returns the created instance of Plugin if it is available.

Returns:

The instance if available

getLogger

default org.slf4j.Logger getLogger()

Returns the assigned logger to this Plugin.

Returns:

The assigned logger