org.cadixdev.lorenz.io

Interface MappingFormat

All Known Subinterfaces:

TextMappingFormat

All Known Implementing Classes:

CSrgMappingFormat, SrgMappingFormat, TSrgMappingFormat

public interface MappingFormat

A representation of a de-obfuscation mapping format.

Since:

0.4.0

Method Summary

Modifier and Type	Method and Description
MappingsReader	createReader(InputStream stream) Creates a MappingsReader from the given InputStream for the mapping format.
default MappingsReader	createReader(Path path) Creates a MappingsReader for the given mappings file Path for the mapping format.
MappingsWriter	createWriter(OutputStream stream) Creates a MappingsWriter from the given OutputStream for the mapping format.
default MappingsWriter	createWriter(Path path) Creates a MappingsWriter for the given mappings file Path for the mapping format.
Optional<String>	getStandardFileExtension() Gets the typically used file extension for the format, if available.
default MappingSet	read(MappingSet mappings, Path path) Reads a mappings file into the given MappingSet.
default MappingSet	read(Path path) Reads a mappings file into a MappingSet.
default void	write(MappingSet mappings, Path path) Writes a mapping set to file.

Method Detail

createReader

MappingsReader createReader(InputStream stream)
                     throws IOException

Creates a MappingsReader from the given InputStream for the mapping format.

Parameters:

stream - The input stream

Returns:

The mapping reader

Throws:

IOException - Should an I/O issue occur

UnsupportedOperationException - If the format does not support reading

createReader

default MappingsReader createReader(Path path)
                             throws IOException

Creates a MappingsReader for the given mappings file Path for the mapping format.

Parameters:

path - The path to the mappings file

Returns:

The mapping reader

Throws:

IOException - Should an I/O issue occur

UnsupportedOperationException - If the format does not support reading

read

default MappingSet read(MappingSet mappings,
                        Path path)
                 throws IOException

Reads a mappings file into the given MappingSet.

Parameters:

mappings - The mapping set to read in to

path - The path of the mappings file

Returns:

The mappings

Throws:

IOException - Should an I/O issue occur

read

default MappingSet read(Path path)
                 throws IOException

Reads a mappings file into a MappingSet.

Parameters:

path - The path of the mappings file

Returns:

The mappings

Throws:

IOException - Should an I/O issue occur

createWriter

MappingsWriter createWriter(OutputStream stream)
                     throws IOException

Creates a MappingsWriter from the given OutputStream for the mapping format.

Parameters:

stream - The output stream

Returns:

The mapping writer

Throws:

IOException - Should an I/O issue occur

UnsupportedOperationException - If the format does not support writing

createWriter

default MappingsWriter createWriter(Path path)
                             throws IOException

Creates a MappingsWriter for the given mappings file Path for the mapping format.

Parameters:

path - The path to the mappings file

Returns:

The mapping writer

Throws:

IOException - Should an I/O issue occur

UnsupportedOperationException - If the format does not support writing

write

default void write(MappingSet mappings,
                   Path path)
            throws IOException

Writes a mapping set to file.

Parameters:

mappings - The mapping set to write

path - The path of the mappings file

Throws:

IOException - Should an I/O issue occur

getStandardFileExtension

Optional<String> getStandardFileExtension()

Gets the typically used file extension for the format, if available.

Returns:

The standard file extension