-
Notifications
You must be signed in to change notification settings - Fork 162
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[ARCHETYPE-691] Refactor FileCharsetDetector #248
Conversation
@@ -1632,6 +1634,18 @@ private FileSet getUnpackagedFileSet( | |||
return createFileSet(excludes, false, filtered, group, includes, defaultEncoding); | |||
} | |||
|
|||
private String getFileCharsetEncoding(File detectedFile, String defaultEncoding) { | |||
try (FileInputStream fileInputStream = new FileInputStream(detectedFile); | |||
BufferedInputStream is = new BufferedInputStream(fileInputStream)) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
put both streams into the try block argument
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
use finally to close these streams?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I don't understand what you mean actually. But I've changed my code, please take a look.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I filed the issue because the helper class was very poorly designed and implemented. I didn't initially realize it was only used in one place and could be inlined so neatly and trivially. However it turns out that it can, and this PR noticeably simplifies the archetype creator class as well as eliminating the charset detectpr class. It's good work.
7dcb773
to
5827f94
Compare
archetype-common/src/main/java/org/apache/maven/archetype/common/util/FileCharsetDetector.java
Outdated
Show resolved
Hide resolved
detector.setText(is); | ||
CharsetMatch match = detector.detect(); | ||
return match.getName().toUpperCase(Locale.ENGLISH); | ||
} catch (IOException e) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is going the wrong way. Use try with resources
private String getFileCharsetEncoding(File detectedFile, String defaultEncoding) { | ||
FileInputStream fileInputStream = null; | ||
BufferedInputStream is = null; | ||
try { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
try (InputStream in = new BufferedInputStream(new FileInputStream(...)))
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay, I now understand what an argument is, and I've updated my code.
5827f94
to
b873572
Compare
… to the usage side.
b873572
to
bac982f
Compare
Remove FileCharsetDetector.java and moved its methods to the usage side.
Following this checklist to help us incorporate your
contribution quickly and easily:
for the change (usually before you start working on it). Trivial changes like typos do not
require a JIRA issue. Your pull request should address just this issue, without
pulling in other changes.
[ARCHETYPE-XXX] SUMMARY
,where you replace
ARCHETYPE-XXX
andSUMMARY
with the appropriate JIRA issue.[ARCHETYPE-XXX] SUMMARY
.Best practice is to use the JIRA issue title in both the pull request title and in the first line of the commit message.
mvn clean verify
to make sure basic checks pass. A more thorough check will be performed on your pull request automatically.If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.
I hereby declare this contribution to be licenced under the Apache License Version 2.0, January 2004
In any other case, please file an Apache Individual Contributor License Agreement.