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.

A feature comparison table can be found here.

  • Enum Constant Details

    • TINY_FILE

      public static final MappingFormat TINY_FILE
      The Tiny mapping format, as specified here.

      Implementation notes

      File metadata only has limited support as of now, and is hardcoded to intermediary counters.

    • 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.

      Implementation notes

      Access modifiers are currently not supported.

    • ENIGMA_DIR

      public static final MappingFormat ENIGMA_DIR
      Enigma's mapping format (in directory form), as specified here.

      Implementation notes

      Access modifiers are currently not supported.

    • SRG_FILE

      public static final MappingFormat SRG_FILE
      The SRG ("Searge RetroGuard") mapping format, as specified here.

      Implementation notes

      Package mappings are currently not supported.

    • XSRG_FILE

      public static final MappingFormat XSRG_FILE
      The XSRG ("Extended SRG") mapping format, as specified here. Same as SRG, but with field descriptors.

      Implementation notes

      Package mappings are currently not supported.

    • 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.

      Implementation notes

      Package mappings are currently not supported.

    • 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.

      Implementation notes

      Package mappings are currently not supported.

    • TSRG_2_FILE

      public static final MappingFormat TSRG_2_FILE
      The TSRG v2 mapping format, as specified here.

      Implementation notes

      Package mappings and static markers for methods are currently not supported.

    • PROGUARD_FILE

      public static final MappingFormat PROGUARD_FILE
      ProGuard's mapping format, as specified here.

      Implementation notes

      Line numbers are currently not supported.

    • 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.

      Implementation notes

      Package mappings are currently not supported.

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