org.cadixdev.lorenz.io

Class TextMappingsReader

java.lang.Object

org.cadixdev.lorenz.io.MappingsReader

org.cadixdev.lorenz.io.TextMappingsReader

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

CSrgReader, SrgReader, TSrgReader

public abstract class TextMappingsReader
extends MappingsReader

An implementation of MappingsReader designed to aid with the implementation of mapping readers for text-based mapping formats.

Since:

0.4.0

See Also:

SrgReader, CSrgReader, TSrgReader

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextMappingsReader.Processor A parser for a given mappings format.

Field Summary

Fields

Modifier and Type	Field and Description
protected Function<MappingSet,TextMappingsReader.Processor>	processor
protected BufferedReader	reader

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TextMappingsReader(Reader reader, Function<MappingSet,TextMappingsReader.Processor> processor) Creates a new mappings reader, for the given Reader.

Method Summary

Modifier and Type	Method and Description
void	close()
MappingSet	read(MappingSet mappings) Reads mappings from the previously given InputStream, to the given MappingSet.

Methods inherited from class org.cadixdev.lorenz.io.MappingsReader

read

Methods inherited from class java.lang.Object

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

Field Detail

reader

protected final BufferedReader reader

processor

protected final Function<MappingSet,TextMappingsReader.Processor> processor

Constructor Detail

TextMappingsReader

protected TextMappingsReader(Reader reader,
                             Function<MappingSet,TextMappingsReader.Processor> processor)

Creates a new mappings reader, for the given Reader.

Parameters:

reader - The reader

processor - The line processor to use for reading the lines

Method Detail

read

public MappingSet read(MappingSet mappings)

Description copied from class: MappingsReader

Reads mappings from the previously given InputStream, to the given MappingSet.

Specified by:

read in class MappingsReader

Parameters:

mappings - The mapping set

Returns:

The mapping set, to allow for chaining

close

public void close()
           throws IOException

Throws:

IOException