Package dev.architectury.loom.metadata

Class QuiltModJson

java.lang.Object

dev.architectury.loom.metadata.QuiltModJson

All Implemented Interfaces:

JsonBackedModMetadataFile, ModMetadataFile

public final class QuiltModJson
extends Object
implements JsonBackedModMetadataFile

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILE_NAME
static final String	JSON5_FILE_NAME

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Set<String>	getAccessTransformers(ModPlatform platform)	Returns the paths to the access transformer files of this mod, or an empty set if absent.
Set<String>	getAccessWideners()	Returns the paths to the access widener file of this mod, or an empty set if absent.
@Nullable com.google.gson.JsonElement	getCustomValue(String key)	Gets a custom value from this mod metadata file.
String	getFileName()	Returns "quilt.mod.json".
@Nullable String	getId()	Returns the mod ID in this mod metadata file, or null if absent.
default Set<String>	getIds()	Returns all mod IDs in this mod metadata file.
List<InterfaceInjectionProcessor.InjectedInterface>	getInjectedInterfaces(@Nullable String modId)	Returns the injected interface data in this mod metadata file.
com.google.gson.JsonObject	getJson()	Returns the backing JSON object of this mod metadata file.
List<String>	getMixinConfigs()	Returns a list of the mixin configs declared in this mod metadata file.
int	hashCode()
static QuiltModJson	of(byte[] utf8)
static QuiltModJson	of(com.google.gson.JsonObject json)
static QuiltModJson	of(File file)
static QuiltModJson	of(String text)
static QuiltModJson	of(Path path)

Methods inherited from class java.lang.Object

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

Field Details

FILE_NAME

public static final String FILE_NAME

See Also:

• Constant Field Values

JSON5_FILE_NAME

public static final String JSON5_FILE_NAME

See Also:

• Constant Field Values

Method Details

of

public static QuiltModJson of(byte[] utf8)

of

public static QuiltModJson of(String text)

of

public static QuiltModJson of(Path path)
                       throws IOException

Throws:

IOException

of

public static QuiltModJson of(File file)
                       throws IOException

Throws:

IOException

of

public static QuiltModJson of(com.google.gson.JsonObject json)

getJson

public com.google.gson.JsonObject getJson()

Description copied from interface: JsonBackedModMetadataFile

Returns the backing JSON object of this mod metadata file..

Specified by:

getJson in interface JsonBackedModMetadataFile

Returns:

the backing JSON object of this mod metadata file

getId

public @Nullable String getId()

Description copied from interface: ModMetadataFile

Returns the mod ID in this mod metadata file, or null if absent..

Specified by:

getId in interface ModMetadataFile

Returns:

the mod ID in this mod metadata file, or null if absent

getAccessWideners

public Set<String> getAccessWideners()

Description copied from interface: ModMetadataFile

Returns the paths to the access widener file of this mod, or an empty set if absent..

Specified by:

getAccessWideners in interface ModMetadataFile

Returns:

the paths to the access widener file of this mod, or an empty set if absent

getAccessTransformers

public Set<String> getAccessTransformers(ModPlatform platform)

Description copied from interface: ModMetadataFile

Returns the paths to the access transformer files of this mod, or an empty set if absent..

Specified by:

getAccessTransformers in interface ModMetadataFile

Parameters:

platform - the platform to run the query on

Returns:

the paths to the access transformer files of this mod, or an empty set if absent

getInjectedInterfaces

public List<InterfaceInjectionProcessor.InjectedInterface> getInjectedInterfaces(@Nullable String modId)

Description copied from interface: ModMetadataFile

Returns the injected interface data in this mod metadata file..

Specified by:

getInjectedInterfaces in interface ModMetadataFile

Parameters:

modId - the mod ID to use as a fallback if ModMetadataFile.getId() returns null

Returns:

the injected interface data in this mod metadata file

getMixinConfigs

public List<String> getMixinConfigs()

Description copied from interface: ModMetadataFile

Returns a list of the mixin configs declared in this mod metadata file..

Specified by:

getMixinConfigs in interface ModMetadataFile

Returns:

a list of the mixin configs declared in this mod metadata file

getFileName

public String getFileName()

Returns "quilt.mod.json"..

Specified by:

getFileName in interface ModMetadataFile

Returns:

"quilt.mod.json"

getCustomValue

public @Nullable com.google.gson.JsonElement getCustomValue(String key)

Description copied from interface: JsonBackedModMetadataFile

Gets a custom value from this mod metadata file.

If the format doesn't support custom values, returns null.

Specified by:

getCustomValue in interface JsonBackedModMetadataFile

Parameters:

key - the key of the custom value

Returns:

the custom value, or null if not found

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getIds

default Set<String> getIds()

Description copied from interface: ModMetadataFile

Returns all mod IDs in this mod metadata file..

Specified by:

getIds in interface ModMetadataFile

Returns:

all mod IDs in this mod metadata file