Package org.cadixdev.lorenz.io

Interface TextMappingFormat

All Superinterfaces:

MappingFormat

All Known Implementing Classes:

CSrgMappingFormat, SrgMappingFormat, TSrgMappingFormat, XSrgMappingFormat

public interface TextMappingFormat
extends MappingFormat

A representation of a de-obfuscation mapping format serialised as text.

Since:

0.4.0

Method Summary

Modifier and Type	Method	Description
default MappingsReader	createReader(java.io.InputStream stream)	Creates a MappingsReader from the given InputStream for the mapping format.
MappingsReader	createReader(java.io.Reader reader)	Creates a MappingsReader from the given Reader for the mapping format.
default MappingsReader	createReader(java.nio.file.Path path)	Creates a MappingsReader for the given mappings file Path for the mapping format.
default MappingsWriter	createWriter(java.io.OutputStream stream)	Creates a MappingsWriter from the given OutputStream for the mapping format.
MappingsWriter	createWriter(java.io.Writer writer)	Creates a MappingsWriter from the given Writer for the mapping format.
default MappingsWriter	createWriter(java.nio.file.Path path)	Creates a MappingsWriter for the given mappings file Path for the mapping format.

Methods inherited from interface org.cadixdev.lorenz.io.MappingFormat

getStandardFileExtension, read, read, write, write

Method Detail

createReader

MappingsReader createReader(java.io.Reader reader)
                     throws java.io.IOException

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

Parameters:

reader - The reader

Returns:

The mapping reader

Throws:

java.io.IOException - Should an I/O issue occur

java.lang.UnsupportedOperationException - If the format does not support reading

createReader

default MappingsReader createReader(java.io.InputStream stream)
                             throws java.io.IOException

Description copied from interface: MappingFormat

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

Specified by:

createReader in interface MappingFormat

Parameters:

stream - The input stream

Returns:

The mapping reader

Throws:

java.io.IOException - Should an I/O issue occur

createReader

default MappingsReader createReader(java.nio.file.Path path)
                             throws java.io.IOException

Description copied from interface: MappingFormat

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

Specified by:

createReader in interface MappingFormat

Parameters:

path - The path to the mappings file

Returns:

The mapping reader

Throws:

java.io.IOException - Should an I/O issue occur

createWriter

MappingsWriter createWriter(java.io.Writer writer)
                     throws java.io.IOException

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

Parameters:

writer - The writer

Returns:

The mapping writer

Throws:

java.io.IOException - Should an I/O issue occur

java.lang.UnsupportedOperationException - If the format does not support writing

createWriter

default MappingsWriter createWriter(java.io.OutputStream stream)
                             throws java.io.IOException

Description copied from interface: MappingFormat

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

Specified by:

createWriter in interface MappingFormat

Parameters:

stream - The output stream

Returns:

The mapping writer

Throws:

java.io.IOException - Should an I/O issue occur

createWriter

default MappingsWriter createWriter(java.nio.file.Path path)
                             throws java.io.IOException

Description copied from interface: MappingFormat

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

Specified by:

createWriter in interface MappingFormat

Parameters:

path - The path to the mappings file

Returns:

The mapping writer

Throws:

java.io.IOException - Should an I/O issue occur