Package net.fabricmc.mappingio.format

Enum Class MappingFormat

java.lang.Object

java.lang.Enum<MappingFormat>

net.fabricmc.mappingio.format.MappingFormat

All Implemented Interfaces:

Serializable, Comparable<MappingFormat>, Constable

public enum MappingFormat
extends Enum<MappingFormat>

Represents a supported mapping format. Every format can be assumed to have an associated reader available.

Feature comparison table:

Format	Namespaces	Field descriptors	Comments	Parameters	Local variables	Metadata
Tiny v1	✔	src	-	-	-	✔ (Currently limited support)
Tiny v2	✔	src	✔	lvIdx invalid input: '&' srcName	lvIdx, lvtIdx, startOpIdx invalid input: '&' srcName	✔
Enigma	-	src	✔	lvIdx	-	-
SRG	-	-	-	-	-	-
XSRG	-	src invalid input: '&' dst	-	-	-	-
JAM	-	src	-	argPos	-	-
CSRG/TSRG	-	-	-	-	-	-
TSRG2	✔	src	-	lvIdx invalid input: '&' srcName	-	-
ProGuard	-	src	-	-	-	-
Recaf Simple	-	src invalid input: '&' dst	-	-	-	-
JOBF	-	src	-	-	-	-

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CSRG_FILE	The CSRG ("Compact SRG", since it saves disk space over SRG) mapping format, as specified here.
ENIGMA_DIR	Enigma's mapping format (in directory form), as specified here.
ENIGMA_FILE	Enigma's mapping format, as specified here.
JAM_FILE	The JAM ("Java Associated Mapping"; formerly SRGX) mapping format, as specified here.
JOBF_FILE	The JOBF mapping format, as specified here.
PROGUARD_FILE	ProGuard's mapping format, as specified here.
RECAF_SIMPLE_FILE	Recaf's Simple mapping format, as specified here.
SRG_FILE	The SRG ("Searge RetroGuard") mapping format, as specified here.
TINY_2_FILE	The Tiny v2 mapping format, as specified here.
TINY_FILE	The Tiny mapping format, as specified here.
TSRG_2_FILE	The TSRG v2 mapping format, as specified here.
TSRG_FILE	The TSRG ("Tiny SRG", since it saves disk space over SRG) mapping format, as specified here.
XSRG_FILE	The XSRG ("Extended SRG") mapping format, as specified here.

Field Summary

Fields

Modifier and Type	Field	Description
final @Nullable String	fileExt
final boolean	hasFieldDescriptors
final boolean	hasNamespaces
final boolean	hasWriter
final String	name
final boolean	supportsArgs
final boolean	supportsComments
final boolean	supportsLocals

Method Summary

Modifier and Type	Method	Description
String	getGlobPattern()
boolean	hasSingleFile()
static MappingFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MappingFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TINY_FILE

public static final MappingFormat TINY_FILE

The Tiny mapping format, as specified here.

TINY_2_FILE

public static final MappingFormat TINY_2_FILE

The Tiny v2 mapping format, as specified here.

ENIGMA_FILE

public static final MappingFormat ENIGMA_FILE

Enigma's mapping format, as specified here.

ENIGMA_DIR

public static final MappingFormat ENIGMA_DIR

Enigma's mapping format (in directory form), as specified here.

SRG_FILE

public static final MappingFormat SRG_FILE

The SRG ("Searge RetroGuard") mapping format, as specified here.

XSRG_FILE

public static final MappingFormat XSRG_FILE

The XSRG ("Extended SRG") mapping format, as specified here. Same as SRG, but with field descriptors.

JAM_FILE

public static final MappingFormat JAM_FILE

The JAM ("Java Associated Mapping"; formerly SRGX) mapping format, as specified here.

CSRG_FILE

public static final MappingFormat CSRG_FILE

The CSRG ("Compact SRG", since it saves disk space over SRG) mapping format, as specified here.

TSRG_FILE

public static final MappingFormat TSRG_FILE

The TSRG ("Tiny SRG", since it saves disk space over SRG) mapping format, as specified here. Same as CSRG, but hierarchical instead of flat.

TSRG_2_FILE

public static final MappingFormat TSRG_2_FILE

The TSRG v2 mapping format, as specified here.

PROGUARD_FILE

public static final MappingFormat PROGUARD_FILE

ProGuard's mapping format, as specified here.

RECAF_SIMPLE_FILE

public static final MappingFormat RECAF_SIMPLE_FILE

Recaf's Simple mapping format, as specified here.

JOBF_FILE

public static final MappingFormat JOBF_FILE

The JOBF mapping format, as specified here.

Field Details

name

public final String name

fileExt

@Nullable
public final @Nullable String fileExt

hasNamespaces

public final boolean hasNamespaces

hasFieldDescriptors

public final boolean hasFieldDescriptors

supportsComments

public final boolean supportsComments

supportsArgs

public final boolean supportsArgs

supportsLocals

public final boolean supportsLocals

hasWriter

public final boolean hasWriter

Method Details

values

public static MappingFormat[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MappingFormat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

hasSingleFile

public boolean hasSingleFile()

getGlobPattern

public String getGlobPattern()