MappingsReader (lorenz 0.5.7 API)

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

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

BinaryMappingsReader, TextMappingsReader
```
public abstract class MappingsReader
extends java.lang.Object
implements java.io.Closeable
```
Represents a reader that reads de-obfuscation mappings.

Since:

0.4.0

See Also:

TextMappingsReader, BinaryMappingsReader

Constructor Summary

Constructors
Constructor Description

MappingsReader()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`MappingSet`	`read()`	Reads mappings from the previously given `InputStream`, to a new `MappingSet`.
`abstract MappingSet`	`read(MappingSet mappings)`	Reads mappings from the previously given `InputStream`, to the given `MappingSet`.

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

- Constructor Detail
  - MappingsReader
```
public MappingsReader()
```
- Method Detail
  - read
```
public MappingSet read()
                throws java.io.IOException
```
    Reads mappings from the previously given InputStream, to a new MappingSet.
    
    Returns:
    
    The mapping set
    
    Throws:
    
    java.io.IOException - Should an I/O issue occur
  - read
```
public abstract MappingSet read(MappingSet mappings)
                         throws java.io.IOException
```
    Reads mappings from the previously given InputStream, to the given MappingSet.
    
    Parameters:
    
    mappings - The mapping set
    
    Returns:
    
    The mapping set, to allow for chaining
    
    Throws:
    
    java.io.IOException - Should an I/O issue occur