Class MappingReader

java.lang.Object

net.fabricmc.mappingio.MappingReader

public final class MappingReader
extends Object

Method Summary

Modifier and Type	Method	Description
static @Nullable MappingFormat	detectFormat(Reader reader)
static @Nullable MappingFormat	detectFormat(Path path)
static List<String>	getNamespaces(Reader reader)
static List<String>	getNamespaces(Reader reader, MappingFormat format)
static List<String>	getNamespaces(Path file)
static List<String>	getNamespaces(Path file, MappingFormat format)
static void	read(Reader reader, MappingFormat format, MappingVisitor visitor)	Tries to read the reader's content using the passed format's mapping reader.
static void	read(Reader reader, MappingVisitor visitor)	Tries to detect the reader's content's format and read it.
static void	read(Path path, MappingFormat format, MappingVisitor visitor)	Tries to read the given path using the passed format's reader.
static void	read(Path path, MappingVisitor visitor)	Tries to detect the format of the given path and read it.

Methods inherited from class Object

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

Method Details

detectFormat

@Nullable
public static @Nullable MappingFormat detectFormat(Path path)
                                            throws IOException

Throws:

IOException

detectFormat

@Nullable
public static @Nullable MappingFormat detectFormat(Reader reader)
                                            throws IOException

Throws:

IOException

getNamespaces

public static List<String> getNamespaces(Path file)
                                  throws IOException

Throws:

IOException

getNamespaces

public static List<String> getNamespaces(Path file,
 MappingFormat format)
                                  throws IOException

Throws:

IOException

getNamespaces

public static List<String> getNamespaces(Reader reader)
                                  throws IOException

Throws:

IOException

getNamespaces

public static List<String> getNamespaces(Reader reader,
 MappingFormat format)
                                  throws IOException

Throws:

IOException

read

public static void read(Path path,
 MappingVisitor visitor)
                 throws IOException

Tries to detect the format of the given path and read it.

Parameters:

path - The path to read from. Can be a file or a directory.

visitor - The receiving visitor.

Throws:

IOException - If the format can't be detected or reading fails.

read

public static void read(Path path,
 MappingFormat format,
 MappingVisitor visitor)
                 throws IOException

Tries to read the given path using the passed format's reader.

Parameters:

path - The path to read from. Can be a file or a directory.

format - The format to use. Has to match the path's format.

visitor - The receiving visitor.

Throws:

IOException - If reading fails.

read

public static void read(Reader reader,
 MappingVisitor visitor)
                 throws IOException

Tries to detect the reader's content's format and read it.

Parameters:

reader - The reader to read from.

visitor - The receiving visitor.

Throws:

IOException - If the format can't be detected or reading fails.

read

public static void read(Reader reader,
 MappingFormat format,
 MappingVisitor visitor)
                 throws IOException

Tries to read the reader's content using the passed format's mapping reader.

Parameters:

reader - The reader to read from.

format - The format to use. Has to match the reader's content's format.

visitor - The receiving visitor.

Throws:

IOException - If reading fails.