TextMappingsReader (lorenz 0.5.8 API)

java.lang.Object
- org.cadixdev.lorenz.io.MappingsReader
- - org.cadixdev.lorenz.io.TextMappingsReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

CSrgReader, SrgReader, TSrgReader, XSrgReader
```
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 Description

static class TextMappingsReader.Processor
A parser for a given mappings format.

Field Summary

Fields
Modifier and Type Field Description

protected java.util.function.Function<MappingSet,TextMappingsReader.Processor> processor

protected java.io.BufferedReader reader

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`TextMappingsReader(java.io.Reader reader, java.util.function.Function<MappingSet,TextMappingsReader.Processor> processor)`	Creates a new mappings reader, for the given `Reader`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	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 java.io.BufferedReader reader
```
  - processor
```
protected final java.util.function.Function<MappingSet,TextMappingsReader.Processor> processor
```
- Constructor Detail
  - TextMappingsReader
```
protected TextMappingsReader(java.io.Reader reader,
                             java.util.function.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 java.io.IOException
```
    Throws:
    
    java.io.IOException