de.awtools.homegen.directory

Interface GHDirectory

All Superinterfaces:

GHEntry

All Known Implementing Classes:

AbstractGHDirectory

public interface GHDirectory
extends GHEntry

Schnittstelle für die Verwaltung eines Verzeichnisses.

Since:

1.3

Version:

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

Author:

by Andre Winkler, $LastChangedBy: andrewinkler $

Field Summary

Fields inherited from interface de.awtools.homegen.directory.GHEntry

ROOT_DIR

Method Summary

Methods

Modifier and Type	Method and Description
void	addDirectory(GHDirectory directory) Fügt ein Unterverzeichnis dem Verzeichnis hinzu.
void	addFile(GHFile file) Fügt eine Datei dem Verzeichnis hinzu.
void	apply(FileWorker fileWorker) Startet die Bearbeitung aller Verzeichnisse und Unterverzeichnisse durch einen FileWorker.
GHFile	findFile(GHFile findme) Sucht nach einem GHFile, welches dem übergebenen File ähnlich ist in Dateiname und Pfad.
GHFile	findFile(GHFile findme, String fileExtension) Sucht nach einem GHFile, welches dem übergebenen File ähnlich ist in Dateiname und Pfad.
List<GHFile>	getAllFiles() Liefert alle Dateien aus allen Verzeichnissen und Unterverzeichnissen.
List<GHDirectory>	getDirectories() Liefert alle Unterverzeichnisse.
GHDirectory	getDirectory(String name) Liefert das Verzeichnis mit dem übergebenen Namen.
GHFile	getFile(String name) Sucht nach einer Datei mit dem angegebenen Namen.
List<GHFile>	getFiles() Liefert die SnippetHtmlFiles die sich in diesem Verzeichnis befinden.
GHDirectory	getParent() Das übergeordnete Verzeichnis.
GHDirectory	getRoot() Liefert das Root-Verzeichnis für diese Verzeichnishierarchie.
boolean	isRootDir() Liefert true, wenn dies das Wurzelverzeichnis der Webpräsenz ist.
Iterator<GHFile>	iterator() Iterator über alle Dateien in dem Verzeichnis und allen Unterverzeichnissen.

Methods inherited from interface de.awtools.homegen.directory.GHEntry

getDirectoryPath, getFile, getLevelFromRoot, getName, getPath, isNewer, printGraph

Method Detail

isRootDir

boolean isRootDir()

Liefert true, wenn dies das Wurzelverzeichnis der Webpräsenz ist.

Returns:

Siehe Methodenbeschreibung.

See Also:

GHEntry.getLevelFromRoot()

getParent

GHDirectory getParent()

Das übergeordnete Verzeichnis. Kann null sein, dann ist dies das Wurzelverzeichnis.

Returns:

Das übergeordnete Verzeichnis.

getRoot

GHDirectory getRoot()

Liefert das Root-Verzeichnis für diese Verzeichnishierarchie.

Returns:

Das Wurzelverzeichnis.

getDirectories

List<GHDirectory> getDirectories()

Liefert alle Unterverzeichnisse.

Returns:

Unterverzeichnisse.

getDirectory

GHDirectory getDirectory(String name)

Liefert das Verzeichnis mit dem übergebenen Namen. Es werden keine Unterverzeichnisse durchsucht.

Parameters:

name - Der Name des gesuchten Verzeichnisses.

Returns:

Das gefundene Verzeichnis oder null wenn keins gefunden.

addDirectory

void addDirectory(GHDirectory directory)

Fügt ein Unterverzeichnis dem Verzeichnis hinzu.

Parameters:

directory - Ein Unterverzeichnis.

getFiles

List<GHFile> getFiles()

Liefert die SnippetHtmlFiles die sich in diesem Verzeichnis befinden.

Returns:

Die SnippetHtmlFiles die diesem Verzeichnis zugeordnet sind.

iterator

Iterator<GHFile> iterator()

Iterator über alle Dateien in dem Verzeichnis und allen Unterverzeichnissen.

Returns:

Iterator über alle Dateien und Unterdateien.

getAllFiles

List<GHFile> getAllFiles()

Liefert alle Dateien aus allen Verzeichnissen und Unterverzeichnissen.

Returns:

Alle Dateien aus allen Unterverzeichnissen.

getFile

GHFile getFile(String name)

Sucht nach einer Datei mit dem angegebenen Namen. Es werden keine Unterverzeichnisse durchsucht!

Parameters:

name - Der Name der gesuchten Datei.

Returns:

Die gefundene Datei.

apply

void apply(FileWorker fileWorker)

Startet die Bearbeitung aller Verzeichnisse und Unterverzeichnisse durch einen FileWorker.

Parameters:

fileWorker - Bearbeitet eine Datei.

findFile

GHFile findFile(GHFile findme)

Sucht nach einem GHFile, welches dem übergebenen File ähnlich ist in Dateiname und Pfad.

Parameters:

findme - Ein Muster der zu suchenden Datei.

Returns:

Die gefundene Datei oder null wenn nichts gefunden.

findFile

GHFile findFile(GHFile findme,
              String fileExtension)

Sucht nach einem GHFile, welches dem übergebenen File ähnlich ist in Dateiname und Pfad. Die Datei-Extension wird bei dem Vergleich, von findMe ignoriert und der Parameter fileExtension für die Suche herangezogen.

Parameters:

findme - Ein Muster der zu suchenden Datei.

fileExtension - .

Returns:

Die gefundene Datei oder null wenn nichts gefunden.

addFile

void addFile(GHFile file)

Fügt eine Datei dem Verzeichnis hinzu.

Parameters:

file - Die Datei, die diesem Verzeichnis zugeordnet werden soll.