Interface PluginMetadata
-
- All Superinterfaces:
Inheritable
- All Known Implementing Classes:
StandardPluginMetadata
public interface PluginMetadata extends Inheritable
Represents specific, unique metadata to a plugin.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Containercontainer()Optional<String>description()Stringentrypoint()Gets theentrypoint.Stringid()Gets theid.Optional<String>name()-
Methods inherited from interface org.spongepowered.plugin.metadata.Inheritable
branding, contributors, dependencies, dependency, links, properties, property, version
-
-
-
-
Method Detail
-
id
String id()
Gets theid.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 theentrypoint.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
nameorOptional.empty()otherwise.
-
description
Optional<String> description()
- Returns:
- The
descriptionorOptional.empty()otherwise.
-
-