<!--- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> <!--- +======================================================================+ |**** ****| |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| |**** DO NOT EDIT DIRECTLY ****| |**** ****| +======================================================================+ | TEMPLATE FILE: readme-md-template.md | | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | +======================================================================+ | | | 1) Re-generate using: mvn commons-build:readme-md | | | | 2) Set the following properties in the component's pom: | | - commons.componentid (required, alphabetic, lower case) | | - commons.release.version (required) | | | | 3) Example Properties | | | | <properties> | | <commons.componentid>math</commons.componentid> | | <commons.release.version>1.2</commons.release.version> | | </properties> | | | +======================================================================+ --->

Apache Commons IO

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.

Getting the latest release

You can download source and binaries from our download page.

Alternatively, you can pull it from the central Maven repositories:

xmlCopy
<dependency>
  <groupId>commons-io</groupId>
  <artifactId>commons-io</artifactId>
  <version>2.22.0</version>
</dependency>

Building

Building requires a Java JDK and Apache Maven.
The required Java version is found in the pom.xml as the maven.compiler.source property.

From a command shell, run mvn without arguments to invoke the default Maven goal to run all tests and checks.

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 existing code style for each file.
• 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.
• Before you push a PR, run mvn (without arguments). This runs the default goal which contains all build checks.
• To see the code coverage report, regardless of coverage failures, run mvn clean site -Dcommons.jacoco.haltOnFailure=false -Pjacoco

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 licensed under the Apache License v2.

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

Donating

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

Additional Resources

• Apache Commons Homepage
• Apache Issue Tracker (JIRA)
• Apache Commons Slack Channel

Apache Commons Components

Please see the list of components