[GitHub] justinleet opened a new pull request #1341: METRON-614: Eliminate use of the default Charset

[GitBox <gi...@apache.org>]

justinleet opened a new pull request #1341: METRON-614: Eliminate use of the default Charset
URL: https://github.com/apache/metron/pull/1341
 
 
   ## Contributor Comments
   Most of the motivation here is to spur discussion about what we want to do.  I changed everything to UTF-8. Because UTF-8 is usually a solid default.
   
   Everything with default charset now uses `StandardCharsets.UTF_8` (with the occasional variant of `StandardCharsets.UTF_8.name())`.
   
   I've done a few things here
   * An IntelliJ driven automatic fix for "Implicit usage of the platform's default charset". This fixes the vast majority of issues.
   * An IntelliJ driven automatic fix for "Standard Charset object can be used". This replaces a few "UTF-8" strings that were floating.
   * Manual replacements for `PrintStream`, `FileReader`, and `FileWriter`.
   ** `PrintStream` just requires modifying the args slightly (need to include `autoFlush` in params).
   ** `FileReader` and `FileWriter` do not accept encoding arguments and are drop in replaced with variants that do.
   * A pass for issues that error-prone caught that IntelliJ didn't. These were typically something like, `"".getBytes()` that were in our tests.
   * Changing the POM to throw compiler errors on default charset issues. Otherwise, it's gonna keep cropping up, at least until our build is substantially cleaner.
   
   As a nice side effect, the build logs are cleaner now that error prone isn't squawking on every default charset.
   
   
   ## Pull Request Checklist
   
   Thank you for submitting a contribution to Apache Metron.  
   Please refer to our [Development Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235) for the complete guide to follow for contributions.  
   Please refer also to our [Build Verification Guidelines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview) for complete smoke testing guides.  
   
   
   In order to streamline the review of the contribution we ask you follow these guidelines and ask you to double check the following:
   
   ### For all changes:
   - [x] Is there a JIRA ticket associated with this PR? If not one needs to be created at [Metron Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel).
   - [x] Does your PR title start with METRON-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
   - [x] Has your PR been rebased against the latest commit within the target branch (typically master)?
   
   
   ### For code changes:
   - [ ] Have you included steps to reproduce the behavior or problem that is being changed or addressed?
   - [ ] Have you included steps or a guide to how the change may be verified and tested manually?
   - [ ] Have you ensured that the full suite of tests and checks have been executed in the root metron folder via:
     ```
     mvn -q clean integration-test install && dev-utilities/build-utils/verify_licenses.sh 
     ```
   
   - [ ] Have you written or updated unit tests and or integration tests to verify your changes?
   - [x] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
   - [ ] Have you verified the basic functionality of the build by building and running locally with Vagrant full-dev environment or the equivalent?
   
   ### For documentation related changes:
   - [ ] Have you ensured that format looks appropriate for the output in which it is rendered by building and verifying the site-book? If not then run the following commands and the verify changes via `site-book/target/site/index.html`:
   
     ```
     cd site-book
     mvn site
     ```
   
   #### Note:
   Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.
   It is also recommended that [travis-ci](https://travis-ci.org) is set up for your personal repository such that your branches are built there before submitting a pull request.
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services