Module org.spongepowered.plugin.metadata

Package org.spongepowered.plugin.metadata.builtin

Class StandardPluginMetadata

java.lang.Object

org.spongepowered.plugin.metadata.builtin.StandardPluginMetadata

All Implemented Interfaces:

PluginMetadata

public final class StandardPluginMetadata
extends Object
implements PluginMetadata

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StandardPluginMetadata.Builder

Method Summary

Modifier and Type	Method	Description
PluginBranding	branding()
static StandardPluginMetadata.Builder	builder()
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()
boolean	equals(Object o)
InheritableMetadata	global()
int	hashCode()
String	id()	Gets the id.
Optional<String>	license()	Gets the license of the data within this container.
PluginLinks	links()
PluginLoaderSpecification	loader()
Optional<String>	name()
InheritableMetadata	override()
Map<String,Object>	properties()
<T> Optional<T>	property(String key)	Gets the property by key.
StandardPluginMetadata.Builder	toBuilder()
String	toString()
ArtifactVersion	version()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

id

public String id()

Description copied from interface: PluginMetadata

Gets the id.

Specified by:

id in interface PluginMetadata

Returns:

The id

See Also:

• Constants.VALID_ID_PATTERN

entrypoints

public PluginEntrypoints entrypoints()

Specified by:

entrypoints in interface PluginMetadata

Returns:

The entrypoints

global

public InheritableMetadata global()

override

public InheritableMetadata override()

version

public ArtifactVersion version()

Specified by:

version in interface PluginMetadata

Returns:

The version.

loader

public PluginLoaderSpecification loader()

Specified by:

loader in interface PluginMetadata

Returns:

The loader.

name

public Optional<String> name()

Specified by:

name in interface PluginMetadata

Returns:

The name or Optional.empty() otherwise.

description

public Optional<String> description()

Specified by:

description in interface PluginMetadata

Returns:

The description or Optional.empty() otherwise.

license

public Optional<String> license()

Description copied from interface: PluginMetadata

Gets the license of the data within this container.

Notable examples include MIT or All Rights Reserved.

Specified by:

license in interface PluginMetadata

Returns:

The license

branding

public PluginBranding branding()

Specified by:

branding in interface PluginMetadata

Returns:

The branding.

links

public PluginLinks links()

Specified by:

links in interface PluginMetadata

Returns:

The links to various web resources.

contributors

public List<PluginContributor> contributors()

Specified by:

contributors in interface PluginMetadata

Returns:

The contributors as an unmodifiable List.

conflicts

public List<PluginConflict> conflicts()

Description copied from interface: PluginMetadata

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.

Specified by:

conflicts in interface PluginMetadata

Returns:

The conflicts as an unmodifiable List.

dependency

public Optional<PluginDependency> dependency(String id)

Description copied from interface: PluginMetadata

Gets the plugin dependency by id.

This maps to PluginDependency.id().

Specified by:

dependency in interface PluginMetadata

Parameters:

id - The id

Returns:

The dependency or Optional.empty() otherwise.

dependencies

public Collection<PluginDependency> dependencies()

Specified by:

dependencies in interface PluginMetadata

Returns:

The dependencies as an unmodifiable Collection.

property

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

Description copied from interface: PluginMetadata

Gets the property by key.

Specified by:

property in interface PluginMetadata

Type Parameters:

T - The type

Parameters:

key - The key

Returns:

The property or Optional.empty() otherwise.

properties

public Map<String,Object> properties()

Specified by:

properties in interface PluginMetadata

Returns:

The properties as an unmodifiable Map.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public StandardPluginMetadata.Builder toBuilder()

builder

public static StandardPluginMetadata.Builder builder()