Add Flat File category (BeanIO, fixedformat4j, Flatpack)#1263
Open
jeyben wants to merge 1 commit into
Open
Conversation
These libraries map fixed-length / delimited flat-file records to and from Java objects and do not fit the CSV section. Per contribution rule 4 (two or more Miscellaneous-style entries sharing a domain may form a new specialized section), they are grouped under a new "Flat File" category.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What
Adds a new Flat File section grouping three maintained, Apache-2.0 libraries that read and write fixed-length / delimited flat-file records by mapping them to and from Java objects:
Why a new category
These are flat-file object-mapping libraries, not CSV parsers, so they don't fit the existing CSV section (the one CSV entry that touches fixed-width, uniVocity-parsers, is primarily a CSV/TSV parser and stays there). Three same-domain libraries that don't fit a pre-existing specialized section is exactly the case contribution rule 4 describes for forming a new specialized section.
Each description states the library's distinguishing approach (annotation vs XML config, fixed-length vs delimited support) per the "unique features" requirement.
Disclosure
I am the author of fixedformat4j. The other two entries (BeanIO, Flatpack) are independent libraries included to populate the category fairly rather than submit a single-entry self-promoting section. All three are Apache-2.0 licensed, documented in English, and not archived.
Checklist
[LIBRARY](LINK) - DESCRIPTION.Summary by cubic
Adds a new Flat File category in the README to group flat-file object-mapping libraries, listing BeanIO, fixedformat4j, and Flatpack with brief descriptions. Updates the table of contents; CSV section remains unchanged since these are not CSV parsers.
Written for commit cd7f30e. Summary will update on new commits.