de.awtools.homegen.directory.utils

Class AbstractDirectoryScanner

java.lang.Object

de.awtools.homegen.directory.utils.AbstractDirectoryScanner

All Implemented Interfaces:

GHDirectoryScanner

Direct Known Subclasses:

FileScanner, SnippetSourceScanner

public abstract class AbstractDirectoryScanner
extends Object
implements GHDirectoryScanner

Utility Klasse für Scanner Implementierungen.

Since:

1.5

Version:

$LastChangedRevision: 2993 $ $LastChangedDate: 2011-11-24 20:51:48 +0100 (Thu, 24 Nov 2011) $

Author:

by Andre Winkler, $LastChangedBy: andrewinkler $

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDirectoryScanner(File _rootDirectory, GHBuilder _entryBuilder) Konstruktor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	findDirectories(GHDirectory parentDirectory) Sucht nach allen Verzeichnissen auf dieser Ebene (parentDirectory) und hängt diese als GHDirectory in das parentDirectory ein.
protected void	findFiles(GHDirectory parentDirectory) Sucht nach allen Dateien auf dieser Ebene (parentDirectory) und hängt diese als GHFile in das parentDirectory ein.
protected GHBuilder	getBuilder() Liefert den Builder zum Bauen der GHDirectory und GHFile Instanzen.
protected File	getRootDirectory() Liefert das Wurzelverzeichnis.
protected void	parseFile(GHFile file) Nachbearbeitung nach GHFile Instanzierung.
GHDirectory	scan() Erstellt einen SnippetDirectory-Tree.
protected void	scanDirectory(GHDirectory directory) Scannt ein Verzeichnis nach Files und Unterverzeichnissen.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDirectoryScanner

protected AbstractDirectoryScanner(File _rootDirectory,
                        GHBuilder _entryBuilder)

Konstruktor.

Parameters:

_rootDirectory - Das Root-Verzeichnis.

Method Detail

getRootDirectory

protected final File getRootDirectory()

Liefert das Wurzelverzeichnis.

Returns:

Das Wurzelverzeichnis.

getBuilder

protected final GHBuilder getBuilder()

Liefert den Builder zum Bauen der GHDirectory und GHFile Instanzen.

Returns:

Der Builder für unseren Scanner.

scan

public final GHDirectory scan()

Erstellt einen SnippetDirectory-Tree.

Specified by:

scan in interface GHDirectoryScanner

Returns:

Das Wurzelverzeichnis des Snippet-Trees.

scanDirectory

protected void scanDirectory(GHDirectory directory)

Scannt ein Verzeichnis nach Files und Unterverzeichnissen.

Parameters:

directory - Das zu untersuchende Verzeichnis.

findFiles

protected final void findFiles(GHDirectory parentDirectory)

Sucht nach allen Dateien auf dieser Ebene (parentDirectory) und hängt diese als GHFile in das parentDirectory ein.

Parameters:

parentDirectory - Das zu untersuchende Verzeichnis.

parseFile

protected void parseFile(GHFile file)

Nachbearbeitung nach GHFile Instanzierung. Bei Bedarf zum Überschreiben freigegeben.

Parameters:

file - File zur Nachbearbeitung.

findDirectories

protected final void findDirectories(GHDirectory parentDirectory)

Sucht nach allen Verzeichnissen auf dieser Ebene (parentDirectory) und hängt diese als GHDirectory in das parentDirectory ein.

Parameters:

parentDirectory - Das zu untersuchende Verzeichnis.