Module org.spongepowered.plugin.metadata

Package org.spongepowered.plugin.metadata.builtin

Class StandardPluginMetadata

java.lang.Object

org.spongepowered.plugin.metadata.builtin.StandardInheritable

org.spongepowered.plugin.metadata.builtin.StandardPluginMetadata

All Implemented Interfaces:

Inheritable, PluginMetadata

public final class StandardPluginMetadata
extends StandardInheritable
implements PluginMetadata

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StandardPluginMetadata.Builder
static final class	StandardPluginMetadata.Deserializer
static final class	StandardPluginMetadata.Serializer

Nested classes/interfaces inherited from class org.spongepowered.plugin.metadata.builtin.StandardInheritable

StandardInheritable.AbstractBuilder<T extends Inheritable,B extends StandardInheritable.AbstractBuilder<T,B>>

Field Summary

Fields inherited from class org.spongepowered.plugin.metadata.builtin.StandardInheritable

branding, contributors, dependencies, links, properties, rawVersion, version

Method Summary

Modifier and Type	Method	Description
static StandardPluginMetadata.Builder	builder()
Container	container()
Optional<String>	description()
String	entrypoint()	Gets the entrypoint.
boolean	equals(Object o)
int	hashCode()
String	id()	Gets the id.
Optional<String>	name()
String	toString()

Methods inherited from class org.spongepowered.plugin.metadata.builtin.StandardInheritable

branding, contributors, dependencies, dependency, links, properties, property, stringJoiner, version

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.spongepowered.plugin.metadata.Inheritable

branding, contributors, dependencies, dependency, links, properties, property, version

Method Details

builder

public static StandardPluginMetadata.Builder builder()

container

public Container container()

Specified by:

container in interface PluginMetadata

Returns:

The container.

id

public String id()

Description copied from interface: PluginMetadata

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 (_)

Specified by:

id in interface PluginMetadata

Returns:

The id

entrypoint

public String entrypoint()

Description copied from interface: PluginMetadata

Gets the entrypoint.

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.

Specified by:

entrypoint in interface PluginMetadata

Returns:

The entrypoint

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.

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 StandardInheritable