You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by sc...@apache.org on 2005/09/19 01:12:53 UTC
svn commit: r289999 - in
/jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io:
CopyUtils.java EndianUtils.java FileCleaner.java FileSystemUtils.java
FileUtils.java FilenameUtils.java HexDump.java IOUtils.java
Author: scolebourne
Date: Sun Sep 18 16:12:45 2005
New Revision: 289999
URL: http://svn.apache.org/viewcvs?rev=289999&view=rev
Log:
Improve javadoc for v1.1
Modified:
jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/CopyUtils.java
jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/EndianUtils.java
jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileCleaner.java
jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileSystemUtils.java
jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileUtils.java
jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FilenameUtils.java
jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/HexDump.java
jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java
Modified: jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/CopyUtils.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/CopyUtils.java?rev=289999&r1=289998&r2=289999&view=diff
==============================================================================
--- jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/CopyUtils.java (original)
+++ jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/CopyUtils.java Sun Sep 18 16:12:45 2005
@@ -100,7 +100,7 @@
* method variants to specify the encoding, each row may
* correspond to up to 2 methods.</p>
*
- * <p>Origin of code: Apache Avalon (Excalibur)</p>
+ * <p>Origin of code: Excalibur.</p>
*
* @author Peter Donald
* @author Jeff Turner
Modified: jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/EndianUtils.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/EndianUtils.java?rev=289999&r1=289998&r2=289999&view=diff
==============================================================================
--- jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/EndianUtils.java (original)
+++ jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/EndianUtils.java Sun Sep 18 16:12:45 2005
@@ -22,11 +22,19 @@
/**
* Utility code for dealing with different endian systems.
- * <br>
+ * <p>
+ * Different computer architectures adopt different conventions for
+ * byte ordering. In so-called "Little Endian" architectures (eg Intel),
+ * the low-order byte is stored in memory at the lowest address, and
+ * subsequent bytes at higher addresses. For "Big Endian" architectures
+ * (eg Motorola), the situation is reversed.
+ * This class helps you solve this incompatability.
+ * <p>
* Origin of code: Apache Avalon (Excalibur)
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version CVS $Revision$ $Date$
+ * @version $Id$
+ * @see org.apache.commons.io.input.SwappedDataInputStream
*/
public class EndianUtils {
Modified: jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileCleaner.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileCleaner.java?rev=289999&r1=289998&r2=289999&view=diff
==============================================================================
--- jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileCleaner.java (original)
+++ jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileCleaner.java Sun Sep 18 16:12:45 2005
@@ -24,10 +24,13 @@
/**
* Keeps track of files awaiting deletion, and deletes them when an associated
* marker object is reclaimed by the garbage collector.
+ * <p>
+ * This utility creates a background thread to handle file deletion.
+ * Each file to be deleted is registered with a handler object.
+ * When the handler object is garbage collected, the file is deleted.
*
* @author Noel Bergman
* @author Martin Cooper
- *
* @version $Id$
*/
public class FileCleaner {
Modified: jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileSystemUtils.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileSystemUtils.java?rev=289999&r1=289998&r2=289999&view=diff
==============================================================================
--- jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileSystemUtils.java (original)
+++ jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileSystemUtils.java Sun Sep 18 16:12:45 2005
@@ -25,7 +25,12 @@
* General File System utilities.
* <p>
* This class provides static utility methods for general file system
- * functions.
+ * functions not provided via the JDK {@link java.io.File File} class.
+ * <p>
+ * The current functions provided are:
+ * <ul>
+ * <li>Get the free space on a drive
+ * </ul>
*
* @author Frank W. Zammetti
* @author Stephen Colebourne
Modified: jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileUtils.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileUtils.java?rev=289999&r1=289998&r2=289999&view=diff
==============================================================================
--- jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileUtils.java (original)
+++ jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileUtils.java Sun Sep 18 16:12:45 2005
@@ -37,26 +37,22 @@
import org.apache.commons.io.filefilter.TrueFileFilter;
/**
- * This class provides basic facilities for manipulating files.
- *
- * <h3>File-related methods</h3>
+ * General file manipulation utilities.
* <p>
- * There are methods to create a {@link #toFile File from a URL}, copy a
- * {@link #copyFileToDirectory File to a directory},
- * copy a {@link #copyFile(File, File) File to another File},
- * copy a {@link #copyURLToFile(URL, File) URL's contents to a File},
- * as well as methods to {@link #deleteDirectory(File) delete} and
- * {@link #cleanDirectory(File) clean} a directory.
- * </p>
- *
- * Common {@link java.io.File} manipulation routines.
- *
- * <h3>Origin of code</h3>
+ * Facilities are provided in the following areas:
* <ul>
- * <li>commons-utils repo</li>
- * <li>Alexandria's FileUtils.</li>
- * <li>Avalon Excalibur's IO.</li>
+ * <li>writing to a file
+ * <li>reading from a file
+ * <li>make a directory including parent directories
+ * <li>copying files and directories
+ * <li>deleting files and directories
+ * <li>converting to and from a URL
+ * <li>listing files and directories by filter and extension
+ * <li>comparing file content
+ * <li>file last changed date
* </ul>
+ * <p>
+ * Origin of code: Excalibur, Alexandria, Commons-Utils
*
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</A>
* @author <a href="mailto:sanders@apache.org">Scott Sanders</a>
Modified: jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FilenameUtils.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FilenameUtils.java?rev=289999&r1=289998&r2=289999&view=diff
==============================================================================
--- jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FilenameUtils.java (original)
+++ jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FilenameUtils.java Sun Sep 18 16:12:45 2005
@@ -22,19 +22,24 @@
import java.util.Stack;
/**
- * Utility class that provides methods to manipulate filenames and filepaths.
+ * General filename and filepath manipulation utilities.
* <p>
* When dealing with filenames you can hit problems when moving from a Windows
* based development machine to a Unix based production machine.
* This class aims to help avoid those problems.
* <p>
+ * <b>NOTE</b>: You may be able to avoid using this class entirely simply by
+ * using JDK {@link java.io.File File} objects and the two argument constructor
+ * {@link java.io.File#File(java.io.File, java.lang.String) File(File,String)}.
+ * <p>
* Most methods on this class are designed to work the same on both Unix and Windows.
* Those that don't include 'System', 'Unix' or 'Windows' in their name.
* <p>
* Most methods recognise both separators (forward and back), and both
* sets of prefixes. See the javadoc of each method for details.
* <p>
- * This class defines six components within a filename (example C:\dev\project\file.txt):
+ * This class defines six components within a filename
+ * (example C:\dev\project\file.txt):
* <ul>
* <li>the prefix - C:\</li>
* <li>the path - dev\project\</li>
@@ -69,13 +74,7 @@
* Both prefix styles are matched always, irrespective of the machine that you are
* currently running on.
* <p>
- * <h3>Origin of code</h3>
- * <ul>
- * <li>Commons Utils</li>
- * <li>Alexandria's FileUtils</li>
- * <li>Avalon Excalibur's IO</li>
- * <li>Tomcat</li>
- * </ul>
+ * Origin of code: Excalibur, Alexandria, Tomcat, Commons-Utils.
*
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</A>
* @author <a href="mailto:sanders@apache.org">Scott Sanders</a>
Modified: jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/HexDump.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/HexDump.java?rev=289999&r1=289998&r2=289999&view=diff
==============================================================================
--- jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/HexDump.java (original)
+++ jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/HexDump.java Sun Sep 18 16:12:45 2005
@@ -21,13 +21,14 @@
/**
* Dumps data in hexadecimal format.
* <p>
- * Derived from a HexDump utility I wrote in June 2001.
+ * Provides a single function to take an array of bytes and display it
+ * in hexadecimal form.
* <p>
- * Taken from the POI project.
+ * Origin of code: POI.
*
- * @author Scott Sanders (sanders at apache dot org)
+ * @author Scott Sanders
* @author Marc Johnson
- * @version $Revision$ $Date$
+ * @version $Id$
*/
public class HexDump {
Modified: jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java?rev=289999&r1=289998&r2=289999&view=diff
==============================================================================
--- jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java (original)
+++ jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java Sun Sep 18 16:12:45 2005
@@ -17,7 +17,6 @@
import java.io.BufferedInputStream;
import java.io.BufferedReader;
-import java.io.BufferedWriter;
import java.io.ByteArrayInputStream;
import java.io.CharArrayWriter;
import java.io.File;
@@ -38,12 +37,12 @@
import org.apache.commons.io.output.ByteArrayOutputStream;
/**
- * General IO Stream manipulation.
+ * General IO stream manipulation utilities.
* <p>
* This class provides static utility methods for input/output operations.
* <ul>
* <li>closeQuietly - these methods close a stream ignoring nulls and exceptions
- * <li>toXxx - these methods read data from a stream
+ * <li>toXxx/read - these methods read data from a stream
* <li>write - these methods write data to a stream
* <li>copy - these methods copy all the data from one stream to another
* <li>contentEquals - these methods compare the content of two streams
@@ -58,7 +57,7 @@
* <p>
* All the methods in this class that read a stream are buffered internally.
* This means that there is no cause to use a <code>BufferedInputStream</code>
- * or <code>BufferedReader</code>. The default buffer size of 4K has been show
+ * or <code>BufferedReader</code>. The default buffer size of 4K has been shown
* to be efficient in tests.
* <p>
* Wherever possible, the methods in this class do <em>not</em> flush or close
@@ -66,7 +65,7 @@
* streams' origin and further use. Thus the caller is still responsible for
* closing streams after use.
* <p>
- * Origin of code: Apache Avalon (Excalibur)
+ * Origin of code: Excalibur.
*
* @author Peter Donald
* @author Jeff Turner
@@ -74,7 +73,7 @@
* @author Stephen Colebourne
* @author Gareth Davis
* @author Ian Springer
- * @version CVS $Revision$ $Date$
+ * @version $Id$
*/
public class IOUtils {
// NOTE: This class is focussed on InputStream, OutputStream, Reader and
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org