Module org.spongepowered.plugin.metadata

Package org.spongepowered.plugin.metadata

Interface PluginMetadata

All Known Implementing Classes:

StandardPluginMetadata

public interface PluginMetadata

Represents the metadata of a plugin.

See Also:

• StandardPluginMetadata, for a generic implementation

Method Summary

Modifier and Type	Method	Description
PluginBranding	branding()
List<PluginConflict>	conflicts()	Gets the known and declared conflicts.
List<PluginContributor>	contributors()
Collection<PluginDependency>	dependencies()
Optional<PluginDependency>	dependency(String id)	Gets the plugin dependency by id.
Optional<String>	description()
PluginEntrypoints	entrypoints()
String	id()	Gets the id.
Optional<String>	license()	Gets the license of the data within this container.
PluginLinks	links()
PluginLoaderSpecification	loader()
Optional<String>	name()
Map<String,Object>	properties()
<T> Optional<T>	property(String key)	Gets the property by key.
ArtifactVersion	version()

Method Details

id

String id()

Gets the id.

Returns:

The id

See Also:

• Constants.VALID_ID_PATTERN

entrypoints

PluginEntrypoints entrypoints()

Returns:

The entrypoints

version

ArtifactVersion version()

Returns:

The version.

loader

PluginLoaderSpecification loader()

Returns:

The loader.

name

Optional<String> name()

Returns:

The name or Optional.empty() otherwise.

description

Optional<String> description()

Returns:

The description or Optional.empty() otherwise.

license

Optional<String> license()

Gets the license of the data within this container.

Notable examples include MIT or All Rights Reserved.

Returns:

The license

branding

PluginBranding branding()

Returns:

The branding.

links

PluginLinks links()

Returns:

The links to various web resources.

contributors

List<PluginContributor> contributors()

Returns:

The contributors as an unmodifiable List.

conflicts

List<PluginConflict> conflicts()

Gets the known and declared conflicts. This list is not exhaustive. Unknown conflicts may not be in this list. This list may contain multiple entries with the same id but with different version ranges and reasons.

Returns:

The conflicts as an unmodifiable List.

dependency

Optional<PluginDependency> dependency(String id)

Gets the plugin dependency by id.

This maps to PluginDependency.id().

Parameters:

id - The id

Returns:

The dependency or Optional.empty() otherwise.

dependencies

Collection<PluginDependency> dependencies()

Returns:

The dependencies as an unmodifiable Collection.

property

<T> Optional<T> property(String key)

Gets the property by key.

Type Parameters:

T - The type

Parameters:

key - The key

Returns:

The property or Optional.empty() otherwise.

properties

Map<String,Object> properties()

Returns:

The properties as an unmodifiable Map.