Package net.fabricmc.loom.configuration.providers.mappings.file

Class FileMappingsSpecBuilderImpl

java.lang.Object

net.fabricmc.loom.configuration.providers.mappings.file.FileMappingsSpecBuilderImpl

All Implemented Interfaces:

FileMappingsSpecBuilder

public class FileMappingsSpecBuilderImpl
extends Object
implements FileMappingsSpecBuilder

Method Summary

Modifier and Type	Method	Description
FileMappingsSpec	build()
static FileMappingsSpecBuilderImpl	builder(FileSpec fileSpec)
FileMappingsSpecBuilder	containsAnnotations()	Marks that the zip file contains annotation data.
FileMappingsSpecBuilderImpl	containsUnpick()	Marks that the zip file contains unpick data.
FileMappingsSpecBuilderImpl	enigmaMappings()	Marks that the file contains Enigma mappings.
FileMappingsSpecBuilderImpl	fallbackNamespaces(String sourceNamespace, String targetNamespace)	Sets the fallback namespaces.
FileMappingsSpecBuilderImpl	mappingPath(String mappingPath)	Sets the mapping path inside a zip or jar.
FileMappingsSpecBuilderImpl	mergeNamespace(String namespace)	Sets the merge namespace of this mappings spec.
FileMappingsSpecBuilderImpl	mergeNamespace(MappingsNamespace namespace)	Sets the merge namespace of this mappings spec.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static FileMappingsSpecBuilderImpl builder(FileSpec fileSpec)

mappingPath

public FileMappingsSpecBuilderImpl mappingPath(String mappingPath)

Description copied from interface: FileMappingsSpecBuilder

Sets the mapping path inside a zip or jar. This will have no effect if the file of this mapping spec is not a zip.

Path components within the path should be separated with /.

The default mapping path is mappings/mappings.tiny, matching regular mapping dependency jars such as Yarn's.

Specified by:

mappingPath in interface FileMappingsSpecBuilder

Parameters:

mappingPath - the mapping path

Returns:

this builder

fallbackNamespaces

public FileMappingsSpecBuilderImpl fallbackNamespaces(String sourceNamespace,
 String targetNamespace)

Description copied from interface: FileMappingsSpecBuilder

Sets the fallback namespaces. They will be used if the mapping format itself doesn't provide namespaces with names (e.g. Enigma mappings).

The default fallback namespaces are intermediary as the source namespace and named as the target namespace as in Yarn.

Specified by:

fallbackNamespaces in interface FileMappingsSpecBuilder

Parameters:

sourceNamespace - the fallback source namespace

targetNamespace - the fallback target namespace

Returns:

this builder

enigmaMappings

public FileMappingsSpecBuilderImpl enigmaMappings()

Description copied from interface: FileMappingsSpecBuilder

Marks that the file contains Enigma mappings. Because they are stored in a directory, the format cannot be auto-detected.

Specified by:

enigmaMappings in interface FileMappingsSpecBuilder

Returns:

this builder

containsAnnotations

public FileMappingsSpecBuilder containsAnnotations()

Description copied from interface: FileMappingsSpecBuilder

Marks that the zip file contains annotation data.

Specified by:

containsAnnotations in interface FileMappingsSpecBuilder

Returns:

this builder

containsUnpick

public FileMappingsSpecBuilderImpl containsUnpick()

Description copied from interface: FileMappingsSpecBuilder

Marks that the zip file contains unpick data.

Specified by:

containsUnpick in interface FileMappingsSpecBuilder

Returns:

this builder

mergeNamespace

public FileMappingsSpecBuilderImpl mergeNamespace(MappingsNamespace namespace)

Description copied from interface: FileMappingsSpecBuilder

Sets the merge namespace of this mappings spec.

The merge namespace is the namespace that is used to match up this layer's names to the rest of the mappings. For example, Yarn mappings should be merged through the intermediary names.

The default merge namespace is MappingsNamespace.INTERMEDIARY.

Specified by:

mergeNamespace in interface FileMappingsSpecBuilder

Parameters:

namespace - the new merge namespace

Returns:

this builder

mergeNamespace

public FileMappingsSpecBuilderImpl mergeNamespace(String namespace)

Description copied from interface: FileMappingsSpecBuilder

Sets the merge namespace of this mappings spec.

The merge namespace is the namespace that is used to match up this layer's names to the rest of the mappings. For example, Yarn mappings should be merged through the intermediary names.

The default merge namespace is intermediary.

Specified by:

mergeNamespace in interface FileMappingsSpecBuilder

Parameters:

namespace - the new merge namespace

Returns:

this builder

build

public FileMappingsSpec build()