Record Class ModMeta

java.lang.Object

java.lang.Record

net.uku3lig.ukulib.utils.ModMeta

Record Components:

id - The unique identifier of the mod

name - The fancy display name of the mod

description - The description of the mod

icon - An optional supplier to a stream, containing the icon of the mod

public record ModMeta(String id, String name, String description, Optional<net.minecraft.server.packs.resources.IoSupplier<@NotNull InputStream>> icon)
extends Record

Platform-independent data class to store basic information about a mod.

Constructor Summary

Constructors

Constructor	Description
ModMeta(String id, String name, String description, Optional<net.minecraft.server.packs.resources.IoSupplier<@NotNull InputStream>> icon)	Creates an instance of a ModMeta record class.

Method Summary

Modifier and Type	Method	Description
String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Optional<net.minecraft.server.packs.resources.IoSupplier<@NotNull InputStream>>	icon()	Returns the value of the icon record component.
String	id()	Returns the value of the id record component.
String	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

ModMeta

public ModMeta(String id,
 String name,
 String description,
 Optional<net.minecraft.server.packs.resources.IoSupplier<@NotNull InputStream>> icon)

Creates an instance of a ModMeta record class.

Parameters:

id - the value for the id record component

name - the value for the name record component

description - the value for the description record component

icon - the value for the icon record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

id

public String id()

Returns the value of the id record component.

Returns:

the value of the id record component

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

icon

public Optional<net.minecraft.server.packs.resources.IoSupplier<@NotNull InputStream>> icon()

Returns the value of the icon record component.

Returns:

the value of the icon record component