Rework the mapping read and write APIs #56
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
MappingWriter
implementations' methods are no longer static, useXyzWriter.getInstance()
instead.MappingWriter#create(...)
has been removed. Useformat.newWriter(...)
instead.MappingReader
is now an interface.getNamespaces(...)
andread(...)
are no longer static.MappingReader.read(path, format, visitor)
, useformat.reader.read(path, visitor)
.MappingReader.read(path, visitor)
, useMappingReader.detectFormat(path).reader.read(path, visitor)
.Motivation
MappingReader
's static methods.UnsupportedOperationException
andIllegalStateException
(see Calling MappingReader.read with an unsupported format results in an undescriptive exception #25).MappingReader.read(path, visitor)
which calledMappingReader.detectFormat(...)
internally. This removal makes Use file extension for CSRG format detection #46 (comment) easier to implement and likely leads to consumers using more performant code paths now (since the less performant one is no longer shorter to type out).Fixes #25.