Update docs and release notes for IO 1.4

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/io/trunk@611375 13f79535-47bb-0310-9956-ffa450edef68

Author: Niall Pemberton

RELEASE-NOTES.txt

@@ -12,7 +12,7 @@ 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.
+file comparators and endian transformation classes.
 
 
 Compatibility with 1.3.2
@@ -30,6 +30,11 @@ It has been built with the JDK source and target options set to JDK 1.3 and, exc
 those implementations, can be used with JDK 1.3 (see IO IO-127).
 
 
+Deprecations from 1.3.2
+-----------------------
+- FileCleaner deprecated in favour of FileCleaningTracker [see IO-116]
+
+
 Bug fixes from 1.3.2
 --------------------
 - FileUtils
@@ -42,6 +47,7 @@ Bug fixes from 1.3.2
 - HexDump
   - HexDump's use of static StringBuffers isn't thread-safe [IO-136]
 
+
 Enhancements from 1.3.2
 -----------------------
 - FileUtils
@@ -82,10 +88,10 @@ Enhancements from 1.3.2
 - Add Singleton Constants to several stream classes [IO-143]
 
 - PrefixFileFilter [IO-126]
-  - Add faciltiy to specify case sensitivty on prefix matching
+  - Add faciltiy to specify case sensitivity on prefix matching
 
 - SuffixFileFilter [IO-126]
-  - Add faciltiy to specify case sensitivty on suffix matching
+  - Add faciltiy to specify case sensitivity on suffix matching
 
 - RegexFileFilter [IO-74]
   - Add new regular expression file filter implementation

xdocs/building.xml

@@ -24,20 +24,35 @@ limitations under the License.
 <!-- ================================================== -->
 <section name="Overview">
 <p>
-  Commons IO uses <a href="http://maven.apache.org">Maven</a> or
+  Commons IO uses <a href="http://maven.apache.org/maven-1.x/">Maven 1</a>,
+  <a href="http://maven.apache.org">Maven 2</a> or
   <a href="http://ant.apache.org">Ant</a> as a build system.
 </p>
 <p>
   You may also be interested in the upgrade notes:<br />
+  Upgrade <a href="upgradeto1_4.html">from 1.3.2 to 1.4</a><br />
   Upgrade <a href="upgradeto1_3_2.html">from 1.3, or 1.3.1 to 1.3.2</a><br />
   Upgrade <a href="upgradeto1_3_1.html">from 1.3 to 1.3.1</a><br />
   Upgrade <a href="upgradeto1_3.html">from 1.2 to 1.3</a><br />
   Upgrade <a href="upgradeto1_2.html">from 1.1 to 1.2</a><br />
   Upgrade <a href="upgradeto1_1.html">from 1.0 to 1.1</a><br />
 </p>
 </section>
+<section name="Maven 2 Goals">
+  <p>
+    The following <strong><i>Maven 2</i></strong> commands can be used to build validator:
+  </p>
+  <ul>
+    <li><code>mvn clean</code> - clean up</li>
+    <li><code>mvn test</code> - compile and run the unit tests</li>
+    <li><code>mvn site</code> - create io documentation</li>
+    <li><code>mvn package</code> - build the jar</li>
+    <li><code>mvn install</code> - build the jar and install in local maven repository</li>
+    <li><code>mvn site assembly:assembly</code> - Create the source and binary distributions</li>
+  </ul>
+</section>
 <!-- ================================================== -->
-<section name="Maven Goals">
+<section name="Maven 1 Goals">
   <p>
     To build a jar file, change into IO's root directory and run "maven jar".
     The result will be in the "target" subdirectory.

xdocs/index.xml

@@ -27,10 +27,11 @@ limitations under the License.
 Commons IO is a library of utilities to assist with developing IO functionality.
 </p>
 <p>
-There are three main areas included:
+There are four main areas included:
 <ul>
 <li>Utility classes - with static methods to perform common tasks</li>
 <li>Filters - various implementations of file filters</li>
+<li>Comparators - various implementations of <code>java.util.Comparator</code> for files</li>
 <li>Streams - useful stream, reader and writer implementations</li>
 </ul>
 </p>
@@ -46,7 +47,8 @@ and various <a href="project-reports.html">project reports</a>.
 The JavaDoc API documents are available online:
 </p>
 <ul>
-<li>The <a href="api-release/index.html">current release 1.3.2</a></li>
+<li>The <a href="api-release/index.html">current release 1.4</a></li>
+<li>The <a href="api-1.3.2/index.html">previous version 1.3.2</a></li>
 <li>The <a href="api-1.3.1/index.html">previous version 1.3.1</a></li>
 <li>The <a href="api-1.3/index.html">previous version 1.3</a></li>
 <li>The <a href="api-1.2/index.html">previous version 1.2</a></li>
@@ -61,9 +63,9 @@ The <a href="cvs-usage.html">subversion repository</a> can be
 <!-- ================================================== -->
 <section name="Releases">
 <p>
-The latest version is v1.3.2. - 
+The latest version is v1.4. - 
 <a href="http://commons.apache.org/downloads/download_io.cgi">Download now!</a><br />
-The <a href="upgradeto1_3_2.html">upgrade notes</a> are also available.
+The <a href="upgradeto1_4.html">upgrade notes</a> are also available.
 
 </p>
 <p>

xdocs/upgradeto1_4.xml

@@ -17,46 +17,123 @@ limitations under the License.
 -->
 <document>
  <properties>
-  <title>Upgrade from 1.3 to 1.4</title>
+  <title>Upgrade from 1.3.2 to 1.4</title>
   <author email="dev@commons.apache.org">Commons Documentation Team</author>
  </properties>
 <body>
 
 <section name="Upgrade">
 <p>
 These are the release notes and advice for upgrading Commons-IO from
-version 1.3 to version 1.4.
+version 1.3.2 to version 1.4.
 <source>
 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.
+file comparators and endian transformation classes.
 
 
-Compatibility with 1.3
-----------------------
+Compatibility with 1.3.2
+------------------------
 Binary compatible - Yes
 
 Source compatible - Yes
 
 Semantic compatible - Yes
   Check the bug fixes section for semantic bug fixes
 
+Commons IO 1.4 introduces four new implementations which depend on JDK 1.4 features
+(CharSequenceReader, FileWriterWithEncoding, IOExceptionWithCause and RegexFileFilter).
+It has been built with the JDK source and target options set to JDK 1.3 and, except for
+those implementations, can be used with JDK 1.3 (see IO IO-127).
 
-Deprecations from 1.3
----------------------
-- FileCleaner deprecated, replaced by FileCleaningTracker
-  - the old class allowed static use only.
-  - instances of the new class may be put into arbitrary scope.
 
+Deprecations from 1.3.2
+-----------------------
+- FileCleaner deprecated in favour of FileCleaningTracker [see IO-116]
 
-Bug fixes from 1.2
-------------------
 
-Enhancements from 1.2
----------------------
+Bug fixes from 1.3.2
+--------------------
+- FileUtils
+  - forceDelete of orphaned Softlinks does not work [IO-147]
+  - Infinite loop on FileUtils.copyDirectory when the destination directory is within
+    the source directory [IO-141]
+  - Add a copyDirectory() method that makes use of FileFilter [IO-105]
+  - Add moveDirectory() and moveFile() methods [IO-77]
+
+- HexDump
+  - HexDump's use of static StringBuffers isn't thread-safe [IO-136]
+
+
+Enhancements from 1.3.2
+-----------------------
+- FileUtils
+  - Add a deleteQuietly method [IO-135]
+
+- FilenameUtils
+  - Add file name extension separator constants[IO-149]
+
+- IOExceptionWithCause [IO-148]
+  - Add a new IOException implementation with constructors which take a cause
+
+- TeeInputStream [IO-129]
+  - Add new Tee input stream implementation
+
+- FileWriterWithEncoding [IO-153]
+  - Add new File Writer implementation that accepts an encoding
+
+- CharSequenceReader [IO-138]
+  - Add new Reader implementation that handles any CharSequence (String,
+    StringBuffer, StringBuilder or CharBuffer) 
+
+- ThesholdingOuputStream [IO-121]
+  - Add a reset() method which sets the count of the bytes written back to zero.
+
+- DeferredFileOutputStream [IO-130]
+  - Add support for temporary files
+
+- ByteArrayOutputStream
+  - Add a new write(InputStream) method [IO-152]
+
+- New Closed Input/Output stream implementations [IO-122]
+  - AutoCloseInputStream - automatically closes and discards the underlying input stream
+  - ClosedInputStream - returns -1 for any read attempts
+  - ClosedOutputStream - throws an IOException for any write attempts
+  - CloseShieldInputStream - prevents the underlying input stream from being closed.
+  - CloseShieldOutputStream - prevents the underlying output stream from being closed.
+
+- Add Singleton Constants to several stream classes [IO-143]
+
+- PrefixFileFilter [IO-126]
+  - Add faciltiy to specify case sensitivity on prefix matching
+
+- SuffixFileFilter [IO-126]
+  - Add faciltiy to specify case sensitivity on suffix matching
+
+- RegexFileFilter [IO-74]
+  - Add new regular expression file filter implementation
+
+- Make IOFileFilter implementations Serializable [IO-131]
+
+- Improve IOFileFilter toString() methods [IO-120]
+
+- Make fields final so classes are immutable/threadsafe [IO-133]
+  - changes to Age, Delegate, Name, Not, Prefix, Regex, Size, Suffix and Wildcard IOFileFilter
+    implementations.
+
+- IOCase
+  - Add a compare method to IOCase [IO-144]
+
+- Add a package of java.util.Comparator implementations for files [IO-145]
+  - DefaultFileComparator - compare files using the default File.compareTo(File) method.
+  - ExtensionFileComparator - compares files using file name extensions.
+  - LastModifiedFileComparator - compares files using the last modified date/time.
+  - NameFileComparator - compares files using file names.
+  - PathFileComparator - compares files using file paths.
+  - SizeFileComparator - compares files using file sizes.
 </source>
 </p>
 </section>