blob: 6c855e4cccf1cb3f9dbe8eaac1d994b8a3b7b6fd [file] [log] [blame]
$Id$
Commons IO Package
Version 1.1
Release Notes
INTRODUCTION:
Commons IO is a package of Java utility classes for java.io's hierarchy.
Classes in this package are considered to be so standard and of such high
reuse as to justify existence in java.io.
Commons IO contains utility classes, stream implementations, file filters,
and endian transformation classes.
Incompatible changes from 1.0
-----------------------------
Binary compatible - ???
Source compatible - ???
Semantic compatible - ???
Deprecations from 1.0
---------------------
- CopyUtils has been deprecated.
Its methods have been moved to IOUtils.
The new IOUtils methods handle nulls better, and have clearer names.
- IOUtils.toByteArray(String) - Use {@link String#getBytes()}
- IOUtils.toString(byte[]) - Use {@link String#String(byte[])}
- IOUtils.toString(byte[],String) - Use {@link String#String(byte[],String)}
Bug fixes from 1.0
------------------
- FileUtils - touch()
Now creates the file if it did not previously exist
- FileUtils - toFile(URL)
Now handles escape syntax such as %20
- FileFilterUtils - makeCVSAware(IOFileFilter)
Fixed bug that caused method to be completely broken
- CountingInputStream
Fixed bug that caused the count to reduce by one at the end of the stream
- CountingInputStream - skip(long)
Bytes from calls to this method were not previously counted
Enhancements from 1.0
---------------------
- FilenameUtils - new class
A static utility class for working with filenames
Seeks to ease the pain of developing on Windows and deploying on Unix
- FileSystemUtils - new class
A static utility class for working with file systems
Provides one method at present, to get the free space on the filing system
- IOUtils - toByteArray(Reader,encoding)
Handles encodings when reading to a byte array
- IOUtils - toCharArray(InputStream)
- toCharArray(InputStream,encoding)
- toCharArray(Reader)
Reads a stream/reader into a charatcter array
- IOUtils - readLines(InputStream)
- readLines(InputStream,encoding)
- readLines(Reader)
Reads a stream/reader line by line into a List of Strings
- IOUtils - toInputStream(String)
- toInputStream(String,encoding)
Creates an input stream that uses the string as a source of data
- IOUtils - writeLines(Collection,lineEnding,OutputStream)
- writeLines(Collection,lineEnding,OutputStream,encoding)
- writeLines(Collection,lineEnding,Writer)
Writes a collection to a file line by line
- IOUtils - write(...)
Write data to a stream/writer (moved from CopyUtils with better null handling)
- IOUtils - copy(...)
Copy data between streams (moved from CopyUtils with better null handling)
- IOUtils - contentEquals(Reader,Reader)
Method to compare the contents of two readers
- FileUtils - toFiles(URL[])
Converts an array of URLs to an array of Files
- FileUtils - copyDirectory()
New methods to copy a directory
- FileUtils - readFileToByteArray(File)
Reads an entire file into a byte array
- FileUtils - writeByteArrayToFile(File,byte[])
Writes a byte array to a file
- FileUtils - readLines(File,encoding)
Reads a file line by line into a List of Strings
- ConditionalFileFilter - new interface
Defines the behaviour of list based filters
- AndFileFilter, OrFileFilter
Now support a list of filters to and/or
- WildcardFilter
New filter that can match using wildcard file names
- FileFilterUtils - makeSVNAware(IOFileFilter)
New method, like makeCVSAware, that ignores Subversion source control directories
- CountingInputStream,CountingOutputStream - resetCount()
Adds the ability to reset the count part way through reading/writing the stream
- DeferredFileOutputStream - writeTo(OutputStream)
New method to allow current contents to be written to a stream [34173]
- DeferredFileOutputStream
Performance optimizations avoiding double buffering [34142]
Feedback
--------
Open source works best when you give feedback.
http://jakarta.apache.org/commons/io/
Please direct all bug reports to Bugzilla.
http://issues.apache.org/bugzilla/buglist.cgi?product=Commons&component=IO
Or subscribe to the commons-user mailing list (prefix emails by [io])
http://jakarta.apache.org/site/mail.html
The Commons-IO Team