Google Git
Sign in
android / platform / external / apache-commons-io / d259b21c
commitd259b21ca24cac31d78a305d60429d96e1789ebb[log] [tgz]
authorArdenL_Liu <liuwei_5201314@qq.com>Wed Sep 14 22:57:11 2022 +0800
committerGitHub <noreply@github.com>Wed Sep 14 10:57:11 2022 -0400
tree0883b3b8f01bbd9e9d05347b962fa9191992f441
parent04f32cf6205672140fad5f4e60e8d997957fcbc6 [diff]
Better docs in IOUtils and IOUtils.byteArray(int size) (#374)

* IOUtils.byteArray(int size) add the verification to assure that the size is legal(size > 0), the illegal(size <=0) should throw IllegalArgumentException.

* The constructure of IOUtils should be Deprecated as FileUtils

* update with the suggestion

* update with the suggestion

* update with the suggestion

* change IOUtilsTest.testByteArrayWithIllegalSize() with @ParameterizedTest

* @Deprecated
    public FileUtils() { //NOSONAR

* update doc with the review suggestion.

* add tag :@throws NegativeArraySizeException if the size is negative.

* rollback the doc of FileUtils.constructure

* update imports of IOUtilsTest.java

* Not so verbose

* Format tweak

Co-authored-by: Gary Gregory <garydgregory@users.noreply.github.com>
2 files changed
tree: 0883b3b8f01bbd9e9d05347b962fa9191992f441
  1. .github/
  2. src/
  3. .gitattributes
  4. .gitignore
  5. CODE_OF_CONDUCT.md
  6. CONTRIBUTING.md
  7. LICENSE.txt
  8. NOTICE.txt
  9. pom.xml
  10. PROPOSAL.html
  11. README.md
  12. RELEASE-NOTES.txt
  13. SECURITY.md
README.md

Apache Commons IO

GitHub Actions Status Coverage Status Maven Central Javadocs CodeQL

The Apache Commons IO library contains utility classes, stream implementations, file filters, file comparators, endian transformation classes, and much more.

Documentation

More information can be found on the Apache Commons IO homepage. The Javadoc can be browsed. Questions related to the usage of Apache Commons IO should be posted to the user mailing list.

Where can I get the latest release?

You can download source and binaries from our download page.

Alternatively you can pull it from the central Maven repositories:

<dependency>
  <groupId>commons-io</groupId>
  <artifactId>commons-io</artifactId>
  <version>2.11.0</version>
</dependency>

Contributing

We accept Pull Requests via GitHub. The developer mailing list is the main channel of communication for contributors. There are some guidelines which will make applying PRs easier for us:

  • No tabs! Please use spaces for indentation.
  • Respect the code style.
  • Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
  • Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running mvn.

If you plan to contribute on a regular basis, please consider filing a contributor license agreement. You can learn more about contributing via GitHub in our contribution guidelines.

License

This code is under the Apache Licence v2.

See the NOTICE.txt file for required notices and attributions.

Donations

You like Apache Commons IO? Then donate back to the ASF to support the development.

Additional Resources