- From: Jean-Guilhem Rouel via cvs-syncmail <cvsmail@w3.org>
- Date: Wed, 16 Jan 2008 17:19:58 +0000
- To: www-validator-cvs@w3.org
Update of /sources/public/2006/unicorn/org/w3c/unicorn/util
In directory hutz:/tmp/cvs-serv5095/org/w3c/unicorn/util
Modified Files:
ListFiles.java
Log Message:
Added some comments
Index: ListFiles.java
===================================================================
RCS file: /sources/public/2006/unicorn/org/w3c/unicorn/util/ListFiles.java,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -d -r1.1.1.1 -r1.2
--- ListFiles.java 31 Aug 2006 09:09:28 -0000 1.1.1.1
+++ ListFiles.java 16 Jan 2008 17:19:56 -0000 1.2
@@ -17,13 +17,20 @@
/**
* ListFiles<br />
* Created: Jun 26, 2006 2:17:42 PM<br />
- * This class provide static method to list file into a directory.
+ * This class provides static methods to list files into a directory.
* @author Jean-Guilhem ROUEL
*/
public class ListFiles {
private static final Log logger = LogFactory.getLog("org.w3c.unicorn.util");
+ /**
+ * List all files matching a pattern in a directory
+ * @param sDirectory the directory to list
+ * @param sFilterPattern only filenames matching this pattern will be returned
+ * @return an array of files matching the pattern
+ * @throws FileNotFoundException
+ */
public static File[] listFiles (
final String sDirectory,
final String sFilterPattern) throws
@@ -59,6 +66,12 @@
return tFile;
}
+ /**
+ * List all filesin a directory
+ * @param sDirectory the directory to list
+ * @return an array of files
+ * @throws FileNotFoundException
+ */
public static File[] listFiles (final String sDirectory)
throws FileNotFoundException {
ListFiles.logger.trace("listFiles(String)");
@@ -80,6 +93,11 @@
return tFile;
}
+ /**
+ * For testing purpose
+ * @param args
+ * @throws FileNotFoundException
+ */
public static void main (String[] args) throws FileNotFoundException {
File[] files = listFiles("/home/jean");
for (final File file : files) {
Received on Wednesday, 16 January 2008 17:20:09 UTC