Module org.spongepowered.plugin.metadata

Package org.spongepowered.plugin.metadata

Interface PluginMetadata

All Superinterfaces:

Inheritable

All Known Implementing Classes:

StandardPluginMetadata

public interface PluginMetadata
extends Inheritable

Represents specific, unique metadata to a plugin.

See Also:

• Inheritable, for metadata that might be shared between multiple plugin metadata
• StandardPluginMetadata, for a generic implementation

Method Summary

Modifier and Type	Method	Description
Container	container()
Optional<String>	description()
String	entrypoint()	Gets the entrypoint.
String	id()	Gets the id.
Optional<String>	name()

Methods inherited from interface org.spongepowered.plugin.metadata.Inheritable

branding, contributors, dependencies, dependency, links, properties, property, version

Method Details

container

Container container()

Returns:

The container.

id

String id()

Gets the id.

Ids must conform to the following requirements:

• Must be between 2 and 64 characters in length
• Must start with a lower case letter (a-z)
• May only contain a mix of lower case letters (a-z), numbers (0-9), dashes (-), and underscores (_)

Returns:

The id

entrypoint

String entrypoint()

Gets the entrypoint.

Consult the vendor for how this field is used. As an example, this could be the name of a module or a fully realized path to a discrete class.

Returns:

The entrypoint

name

Optional<String> name()

Returns:

The name or Optional.empty() otherwise.

description

Optional<String> description()

Returns:

The description or Optional.empty() otherwise.