Module org.spongepowered.plugin.metadata

Package org.spongepowered.plugin.metadata.model

Interface PluginDependency

All Known Implementing Classes:

StandardPluginDependency

public interface PluginDependency

Specification for an entity considered to be a "dependency" for an inheritable or plugin metadata.

Consult the vendor for further information on how this is used.

See Also:

• StandardPluginDependency, for a generic implementation

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	PluginDependency.LoadOrder	Represents the ordering of how dependencies are loaded versus others.

Method Summary

Modifier and Type	Method	Description
String	id()	Gets the id.
PluginDependency.LoadOrder	loadOrder()
boolean	optional()
VersionRange	version()

Method Details

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

version

VersionRange version()

Returns:

The version, as a maven range.

loadOrder

PluginDependency.LoadOrder loadOrder()

Returns:

The load order

optional

boolean optional()

Returns:

True if optional, false if not