Package hudson.util

Class FileVisitor

java.lang.Object

hudson.util.FileVisitor

Direct Known Subclasses:

Archiver

public abstract class FileVisitor
extends Object

Visits files in a directory recursively.

Since:

1.343

See Also:

DirScanner

Constructor Summary

Constructors

Constructor	Description
FileVisitor()

Method Summary

Modifier and Type	Method	Description
boolean	understandsSymlink()	Some visitors can handle symlinks as symlinks.
abstract void	visit(File f, String relativePath)	Called for each file and directory that matches the criteria implied by DirScanner
void	visitSymlink(File link, String target, String relativePath)	Some visitors can handle symlinks as symlinks.
FileVisitor	with(FileFilter f)	Decorates a visitor by a given filter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileVisitor

public FileVisitor()

Method Detail

visit

public abstract void visit(File f,
                           String relativePath)
                    throws IOException

Called for each file and directory that matches the criteria implied by DirScanner

Parameters:

f - Either a file or a directory.

relativePath - The file/directory name in question

Throws:

IOException

visitSymlink

public void visitSymlink(File link,
                         String target,
                         String relativePath)
                  throws IOException

Some visitors can handle symlinks as symlinks. Those visitors should implement this method to provide a different handling for symlink.

This method is invoked by those DirScanners that can handle symlinks as symlinks. (Not every DirScanners are capable of doing that, as proper symlink handling requires letting visitors decide whether or not to descend into a symlink directory.)

Throws:

IOException

understandsSymlink

public boolean understandsSymlink()

Some visitors can handle symlinks as symlinks. Those visitors should implement this method and return true to have callers invoke visitSymlink(File, String, String). Note that failures to detect or read symlinks on certain platforms can cause visit(java.io.File, java.lang.String) to be called on a file which is actually a symlink.

with

public final FileVisitor with(FileFilter f)

Decorates a visitor by a given filter.