Browse Source

More javadoc

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@277647 13f79535-47bb-0310-9956-ffa450edef68
master
Matthew Jason Benson 20 years ago
parent
commit
4c89cabbb8
1 changed files with 15 additions and 0 deletions
  1. +15
    -0
      src/main/org/apache/tools/ant/DirectoryScanner.java

+ 15
- 0
src/main/org/apache/tools/ant/DirectoryScanner.java View File

@@ -1433,6 +1433,7 @@ public class DirectoryScanner
* Return a cached result of list performed on file, if * Return a cached result of list performed on file, if
* available. Invokes the method and caches the result otherwise. * available. Invokes the method and caches the result otherwise.
* *
* @param file File (dir) to list.
* @since Ant 1.6 * @since Ant 1.6
*/ */
private String[] list(File file) { private String[] list(File file) {
@@ -1451,6 +1452,8 @@ public class DirectoryScanner
* insensitive manner in order to find a file that matches the * insensitive manner in order to find a file that matches the
* given name. * given name.
* *
* @param base base File (dir).
* @param path file path.
* @return File object that points to the file in question. if it * @return File object that points to the file in question. if it
* hasn't been found it will simply be <code>new File(base, * hasn't been found it will simply be <code>new File(base,
* path)</code>. * path)</code>.
@@ -1468,6 +1471,8 @@ public class DirectoryScanner
* insensitive manner in order to find a file that matches the * insensitive manner in order to find a file that matches the
* given stack of names. * given stack of names.
* *
* @param base base File (dir).
* @param pathElements Vector of path elements (dirs...file).
* @return File object that points to the file in question or null. * @return File object that points to the file in question or null.
* *
* @since Ant 1.6 * @since Ant 1.6
@@ -1504,6 +1509,8 @@ public class DirectoryScanner
* From <code>base</code> traverse the filesystem in order to find * From <code>base</code> traverse the filesystem in order to find
* a file that matches the given name. * a file that matches the given name.
* *
* @param base base File (dir).
* @param path file path.
* @return File object that points to the file in question or null. * @return File object that points to the file in question or null.
* *
* @since Ant 1.6 * @since Ant 1.6
@@ -1516,6 +1523,8 @@ public class DirectoryScanner
* From <code>base</code> traverse the filesystem in order to find * From <code>base</code> traverse the filesystem in order to find
* a file that matches the given stack of names. * a file that matches the given stack of names.
* *
* @param base base File (dir).
* @param pathElements Vector of path elements (dirs...file).
* @return File object that points to the file in question or null. * @return File object that points to the file in question or null.
* *
* @since Ant 1.6 * @since Ant 1.6
@@ -1545,6 +1554,8 @@ public class DirectoryScanner
/** /**
* Do we have to traverse a symlink when trying to reach path from * Do we have to traverse a symlink when trying to reach path from
* basedir? * basedir?
* @param base base File (dir).
* @param path file path.
* @since Ant 1.6 * @since Ant 1.6
*/ */
private boolean isSymlink(File base, String path) { private boolean isSymlink(File base, String path) {
@@ -1554,6 +1565,8 @@ public class DirectoryScanner
/** /**
* Do we have to traverse a symlink when trying to reach path from * Do we have to traverse a symlink when trying to reach path from
* basedir? * basedir?
* @param base base File (dir).
* @param pathElements Vector of path elements (dirs...file).
* @since Ant 1.6 * @since Ant 1.6
*/ */
private boolean isSymlink(File base, Vector pathElements) { private boolean isSymlink(File base, Vector pathElements) {
@@ -1617,6 +1630,8 @@ public class DirectoryScanner
* Add all patterns that are not real patterns (do not contain * Add all patterns that are not real patterns (do not contain
* wildcards) to the set and returns the real patterns. * wildcards) to the set and returns the real patterns.
* *
* @param set Set to populate.
* @param patterns String[] of patterns.
* @since Ant 1.7 * @since Ant 1.7
*/ */
private String[] fillNonPatternSet(Set set, String[] patterns) { private String[] fillNonPatternSet(Set set, String[] patterns) {


Loading…
Cancel
Save