org.cadixdev.lorenz.io

Class MappingsWriter

java.lang.Object

org.cadixdev.lorenz.io.MappingsWriter

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

BinaryMappingsWriter, TextMappingsWriter

public abstract class MappingsWriter
extends Object
implements Closeable

Represents a writer, that is capable of writing de-obfuscation mappings.

Each mappings writer will be designed for a specific mapping format, and intended to be used with try-for-resources.

Since:

0.4.0

See Also:

TextMappingsWriter, BinaryMappingsWriter

Field Summary

Fields

Modifier and Type	Field and Description
protected static Comparator<FieldMapping>	ALPHABETISE_FIELDS Deprecated. 0.5.5 Use getConfig() MappingsWriterConfig.getFieldMappingComparator() instead
protected static Comparator<Mapping>	ALPHABETISE_MAPPINGS Deprecated. 0.5.5 Use getConfig() MappingsWriterConfig.getClassMappingComparator() instead
protected static Comparator<MethodMapping>	ALPHABETISE_METHODS Deprecated. 0.5.5 Use getConfig() MappingsWriterConfig.getMethodMappingComparator() instead
protected MappingsWriterConfig	config

Constructor Summary

Constructors

Constructor and Description
MappingsWriter()

Method Summary

Modifier and Type	Method and Description
MappingsWriterConfig	getConfig() Gets the active writer configuration for this mappings writer.
void	setConfig(MappingsWriterConfig config) Sets the active writer configuration for this mappings writer - allowing the output of the writer to be fine-tuned to fit the environment in use.
abstract void	write(MappingSet mappings) Writes the given mappings to the previously given output.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Field Detail

ALPHABETISE_MAPPINGS

@Deprecated
protected static final Comparator<Mapping> ALPHABETISE_MAPPINGS

Deprecated. 0.5.5 Use getConfig() MappingsWriterConfig.getClassMappingComparator() instead

A Comparator used to alphabetise a collection of Mappings.

ALPHABETISE_FIELDS

@Deprecated
protected static final Comparator<FieldMapping> ALPHABETISE_FIELDS

Deprecated. 0.5.5 Use getConfig() MappingsWriterConfig.getFieldMappingComparator() instead

A Comparator used to alphabetise a collection of FieldMappings.

Since:

0.5.0

ALPHABETISE_METHODS

@Deprecated
protected static final Comparator<MethodMapping> ALPHABETISE_METHODS

Deprecated. 0.5.5 Use getConfig() MappingsWriterConfig.getMethodMappingComparator() instead

A Comparator used to alphabetise a collection of MethodMappings.

Since:

0.5.0

config

protected MappingsWriterConfig config

Constructor Detail

MappingsWriter

public MappingsWriter()

Method Detail

getConfig

public MappingsWriterConfig getConfig()

Gets the active writer configuration for this mappings writer.

Returns:

The writer configuration

Since:

0.5.5

setConfig

public void setConfig(MappingsWriterConfig config)

Sets the active writer configuration for this mappings writer - allowing the output of the writer to be fine-tuned to fit the environment in use.

Parameters:

config - The writer configuration

Throws:

NullPointerException - If config is null

Since:

0.5.5

write

public abstract void write(MappingSet mappings)
                    throws IOException

Writes the given mappings to the previously given output.

Parameters:

mappings - The mapping set

Throws:

IOException - Should an IO issue occur