net.fabricmc.mapping.reader.v2

Interface TinyMetadata

public interface TinyMetadata

Metadata for a Tiny V2 mapping file. Implementations are immutable and should be lightweight POJOs that are safe to be referenced.

Method Summary

Modifier and Type	Method and Description
int	getMajorVersion() Gets the major version of the mapping.
int	getMinorVersion() Gets the minor version of the mapping.
List<String>	getNamespaces() Gets the namespaces in this mapping in the order they are listed.
Map<String,String>	getProperties() Gets the properties in this Tiny V2 mapping, appearing in key-value pairs.
default int	index(String namespace) Utility method to efficiently index a namespace's position in this mapping file.

Method Detail

getMajorVersion

int getMajorVersion()

Gets the major version of the mapping.

This number is supposed to be non-negative, but a negative value may appear.

Returns:

the major version

getMinorVersion

int getMinorVersion()

Gets the minor version of the mapping.

This number is supposed to be non-negative, but a negative value may appear.

Returns:

the minor version

getNamespaces

List<String> getNamespaces()

Gets the namespaces in this mapping in the order they are listed.

The returned list is immutable.

Returns:

the list of namespaces

getProperties

Map<String,String> getProperties()

Gets the properties in this Tiny V2 mapping, appearing in key-value pairs.

The property map's iteration order is the same as the order they appear in the Tiny V2 mapping.

Note: the values in these properties may be null, meaning there is a key without an associated value. The key cannot be null.

The returned map is immutable.

Returns:

the properties

index

default int index(String namespace)

Utility method to efficiently index a namespace's position in this mapping file.

A custom implementation should be more efficient than calling getNamespaces().indexOf(namespace).

Parameters:

namespace - the literal namespace

Returns:

the namespace's index, or -1 if the namespace does not exist