Class ModMetadata

java.lang.Object

my.celium.org.metadata.ModMetadata

public final class ModMetadata
extends Object

Small immutable description of a mod that uses Mycel.

A dependent mod registers one instance via Mycel.registerMod(...). Mycel uses it for logging context, configuration file names, translation namespaces, diagnostics and (opt-in) update checking.

Mycel never hardcodes known mods; any mod may register itself.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ModMetadata.Builder	Fluent builder with validation.

Method Summary

Modifier and Type	Method	Description
List<String>	authors()	Authors, never null (possibly empty).
static ModMetadata.Builder	builder(String id, String name, String version)
boolean	equals(Object o)
int	hashCode()
String	id()	Lowercase namespaced id, e.g.
String	name()	Human readable name, e.g.
String	toString()
String	updateUrl()	Optional URL returning update metadata JSON for this mod.
String	version()	Mod version string, e.g.
String	website()	Project website, may be null.

Methods inherited from class Object

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

Method Details

id

public String id()

Lowercase namespaced id, e.g. "doubledoors".

name

public String name()

Human readable name, e.g. "Double Doors".

version

public String version()

Mod version string, e.g. "1.4.0".

website

public String website()

Project website, may be null.

authors

public List<String> authors()

Authors, never null (possibly empty).

updateUrl

public String updateUrl()

Optional URL returning update metadata JSON for this mod. Update checking is asynchronous, cached and failure-tolerant. null disables update checking for this mod.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static ModMetadata.Builder builder(String id,
 String name,
 String version)