Module org.spongepowered.plugin.metadata

Package org.spongepowered.plugin.metadata.builtin

Class MetadataContainer

java.lang.Object

org.spongepowered.plugin.metadata.builtin.MetadataContainer

All Implemented Interfaces:

Container

public final class MetadataContainer
extends Object
implements Container

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MetadataContainer.Builder
static final class	MetadataContainer.Serializer

Method Summary

Modifier and Type	Method	Description
Optional<Inheritable>	globalMetadata()
String	license()	Gets the license of the data within this container.
StandardContainerLoader	loader()
Optional<String>	mappings()	Gets the mappings that code within this container might be written in.
Set<PluginMetadata>	metadata()
Optional<PluginMetadata>	metadata(String id)	Gets a plugin metadata by its id.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

loader

public StandardContainerLoader loader()

Specified by:

loader in interface Container

Returns:

The loader.

license

public String license()

Description copied from interface: Container

Gets the license of the data within this container.

Consult the vendor for how this field is used.

In the generic implementation, a license's name is expected.

Notable examples include MIT or All Rights Reserved.

Specified by:

license in interface Container

Returns:

The license

mappings

public Optional<String> mappings()

Description copied from interface: Container

Gets the mappings that code within this container might be written in.

The format of this string should be in maven dependency format (group:artifact:version).

Consult the vendor for how this field is used. As an example, that entity could use this purely for information purposes or go farther and perform artifact remapping from these mappings to another.

Specified by:

mappings in interface Container

Returns:

The mappings or Optional.empty() otherwise

globalMetadata

public Optional<Inheritable> globalMetadata()

Specified by:

globalMetadata in interface Container

Returns:

The global metadata or Optional.empty() otherwise

metadata

public Optional<PluginMetadata> metadata(String id)

Description copied from interface: Container

Gets a plugin metadata by its id.

This maps to PluginMetadata.id().

Specified by:

metadata in interface Container

Parameters:

id - The id

Returns:

The plugin metadata or Optional.empty() otherwise

metadata

public Set<PluginMetadata> metadata()

Specified by:

metadata in interface Container

Returns:

All of the plugin metadata as an unmodifiable Set.

toString

public String toString()

Overrides:

toString in class Object