Package org.jppf.doc

Class FileExplorer

java.lang.Object

org.jppf.doc.FileExplorer

Direct Known Subclasses:

AuthorsFileExplorer

public abstract class FileExplorer
extends Object

Author:

Laurent Cohen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	FileExplorer.ExploreFilter	File filter based on a set of extensions.

Constructor Summary

Constructors

Constructor	Description
FileExplorer(File root, String... extensions)	Intiialize this file explorer.
FileExplorer(String root, String... extensions)	Intiialize this file explorer.

Method Summary

Modifier and Type	Method	Description
abstract void	afterExploreDir(File dir)	Called after exploring a directory.
abstract void	afterReadFile(File file, String content)	Called before reading the content of the file currently explored.
abstract void	beforeExploreDir(File dir)	Called before exploring a directory.
abstract void	beforeReadFile(File file)	Called before reading the content of the file currently explored.
void	explore()

Methods inherited from class java.lang.Object

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

Constructor Details

FileExplorer

public FileExplorer(String root,
 String... extensions)

Intiialize this file explorer.

Parameters:

root - the root of the file hierarchy to explore.

extensions - the accepted file extensions.

FileExplorer

public FileExplorer(File root,
 String... extensions)

Intiialize this file explorer.

Parameters:

root - the root of the file hierarchy to explore.

extensions - the accepted file extensions.

Method Details

beforeReadFile

public abstract void beforeReadFile(File file)

Called before reading the content of the file currently explored.

Parameters:

file - the file being explored.

afterReadFile

public abstract void afterReadFile(File file,
 String content)

Called before reading the content of the file currently explored.

Parameters:

file - the file being explored.

content - the file content as a string.

beforeExploreDir

public abstract void beforeExploreDir(File dir)

Called before exploring a directory.

Parameters:

dir - the directory being explored.

afterExploreDir

public abstract void afterExploreDir(File dir)

Called after exploring a directory.

Parameters:

dir - the directory being explored.

explore

public void explore()