de.awtools.homegen.directory.utils

Class AbstractGHDirectory

java.lang.Object

de.awtools.homegen.directory.utils.AbstractGHEntry

de.awtools.homegen.directory.utils.AbstractGHDirectory

All Implemented Interfaces:

GHDirectory, GHEntry

public abstract class AbstractGHDirectory
extends AbstractGHEntry
implements GHDirectory

Utility Implementierung von GHDirectory.

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGHDirectory(File _rootDir) Konstruktor für das Wurzelverzeichnis.
protected	AbstractGHDirectory(GHDirectory _parent, File _directory, String _name, int _level) Konstruktor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDirectory(GHDirectory dir) Fügt ein weiteres Unterverzeichnis hinzu.
void	addFile(GHFile file) Fügt ein weiteres Snippet hinzu.
void	apply(FileWorker fileWorker) Startet die Bearbeitung aller Verzeichnisse und Unterverzeichnisse durch einen FileWorker.
boolean	equals(Object _directory)
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 die Unterverzeichnisse.
GHDirectory	getDirectory(String criteria) Liefert das Verzeichnis mit dem übergebenen Namen.
List<GHDirectory>	getDirectoryPath() Liefert den GHDirectory Pfad von der Wurzel bis zu diesem Eintrag.
File	getFile() Liefert das File Objekt für dieses Verzeichnis.
GHFile	getFile(String _name) Sucht nach einer Datei mit dem angegebenen Namen.
List<GHFile>	getFiles() Liefert die SnippetHtmlFiles die sich in diesem Verzeichnis befinden.
int	getLevelFromRoot() Liefert die Anzahl der cd ..
String	getName() Der Name für das Verzeichnis.
GHDirectory	getParent() Liefert das übergeordnete Verzeichnis.
String	getPath() Liefert einen Pfad von der Wurzel bis in dieses Verzeichnis.
GHDirectory	getRoot() Liefer das Root-Verzeichnis für diese Verzeichnishierarchie.
int	hashCode()
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.
String	printGraph() Liefert eine Skizze der Verzeichnisstruktur.
String	toString()

Methods inherited from class de.awtools.homegen.directory.utils.AbstractGHEntry

isNewer

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

isNewer

Constructor Detail

AbstractGHDirectory

protected AbstractGHDirectory(File _rootDir)

Konstruktor für das Wurzelverzeichnis.

Parameters:

_rootDir - Das Wurzelverzeichnis.

AbstractGHDirectory

protected AbstractGHDirectory(GHDirectory _parent,
                   File _directory,
                   String _name,
                   int _level)

Konstruktor.

Parameters:

_parent - Das übergeordnete Verzeichnis.

_directory - Das zugeordnete Verzeichnis.

_name - Name für das Verzeichnis.

_level - Der sogenannte 'level from root'.

Method Detail

getName

public final String getName()

Der Name für das Verzeichnis.

Specified by:

getName in interface GHEntry

Returns:

Der Name für das Verzeichnis.

getPath

public final String getPath()

Liefert einen Pfad von der Wurzel bis in dieses Verzeichnis. Die einzelnen Verzeichnisse auf diesem Pfad sind '/' separiert.

Specified by:

getPath in interface GHEntry

Returns:

Eine '/' separierte Aufzählung von Verzeichnissen.

getDirectoryPath

public final List<GHDirectory> getDirectoryPath()

Liefert den GHDirectory Pfad von der Wurzel bis zu diesem Eintrag.

Specified by:

getDirectoryPath in interface GHEntry

Returns:

Eine Liste mit dem GHDirectory-Pfad von der Wurzel bis zu diesem Eintrag.

getFile

public final File getFile()

Description copied from interface: GHEntry

Liefert das File Objekt für dieses Verzeichnis. Für das Maven-Homepage-Plugin ist dies i.d.R. das Verzeichnis target/www-prep.

Specified by:

getFile in interface GHEntry

Returns:

Das File Objekt zu diesem Verzeichnis.

See Also:

GHEntry.getFile()

getLevelFromRoot

public final int getLevelFromRoot()

Description copied from interface: GHEntry

Liefert die Anzahl der cd .. Aufrufe bis man sich im Root-Verzeichnis der Webpräsenz befindet. Liefert diese Methode 0 zurück, ist dies das Root-SnippetDirectory der Anwendung.

Specified by:

getLevelFromRoot in interface GHEntry

Returns:

Anzahl der Stufen bis in das Root-Verzeichnis der Webpräsenz.

See Also:

GHEntry.getLevelFromRoot()

isRootDir

public final boolean isRootDir()

Description copied from interface: GHDirectory

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

Specified by:

isRootDir in interface GHDirectory

Returns:

Siehe Methodenbeschreibung.

See Also:

GHDirectory.isRootDir()

getParent

public final GHDirectory getParent()

Liefert das übergeordnete Verzeichnis.

Specified by:

getParent in interface GHDirectory

Returns:

Ein übergeordnetes Verzeichnis oder null, wenn dies das Wurzelverzeichnis ist.

See Also:

GHDirectory.getParent()

getRoot

public final GHDirectory getRoot()

Liefer das Root-Verzeichnis für diese Verzeichnishierarchie.

Specified by:

getRoot in interface GHDirectory

Returns:

Das Wurzelverzeichnis.

getDirectories

public final List<GHDirectory> getDirectories()

Liefert die Unterverzeichnisse.

Specified by:

getDirectories in interface GHDirectory

Returns:

Unterverzeichnisse.

See Also:

GHDirectory.getDirectories()

getDirectory

public final GHDirectory getDirectory(String criteria)

Liefert das Verzeichnis mit dem übergebenen Namen.

Specified by:

getDirectory in interface GHDirectory

Parameters:

criteria - Der Name des gesuchten Verzeichnisses.

Returns:

Das gefundene Verzeichnis oder null wenn keins gefunden.

addDirectory

public final void addDirectory(GHDirectory dir)

Fügt ein weiteres Unterverzeichnis hinzu.

Specified by:

addDirectory in interface GHDirectory

Parameters:

dir - Ein Unterverzeichnis.

getFiles

public final List<GHFile> getFiles()

Description copied from interface: GHDirectory

Liefert die SnippetHtmlFiles die sich in diesem Verzeichnis befinden.

Specified by:

getFiles in interface GHDirectory

Returns:

Die SnippetHtmlFiles die diesem Verzeichnis zugeordnet sind.

See Also:

GHDirectory.getFiles()

addFile

public final void addFile(GHFile file)

Fügt ein weiteres Snippet hinzu.

Specified by:

addFile in interface GHDirectory

Parameters:

file - Ein File.

See Also:

GHDirectory.addFile(de.awtools.homegen.directory.GHFile)

iterator

public final Iterator<GHFile> iterator()

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

Specified by:

iterator in interface GHDirectory

Returns:

Iterator über alle Dateien und Unterdateien.

getAllFiles

public final List<GHFile> getAllFiles()

Liefert alle Dateien aus allen Verzeichnissen und Unterverzeichnissen.

Specified by:

getAllFiles in interface GHDirectory

Returns:

Alle Dateien aus allen Unterverzeichnissen.

getFile

public final GHFile getFile(String _name)

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

Specified by:

getFile in interface GHDirectory

Parameters:

_name - Der Name der gesuchten Datei.

Returns:

Die gefundene Datei.

findFile

public final GHFile findFile(GHFile findme)

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

Specified by:

findFile in interface GHDirectory

Parameters:

findme - Ein Muster der zu suchenden Datei.

Returns:

Die gefundene Datei oder null wenn nichts gefunden.

findFile

public final 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.

Specified by:

findFile in interface GHDirectory

Parameters:

findme - Ein Muster der zu suchenden Datei.

fileExtension - .

Returns:

Die gefundene Datei oder null wenn nichts gefunden.

apply

public final void apply(FileWorker fileWorker)

Startet die Bearbeitung aller Verzeichnisse und Unterverzeichnisse durch einen FileWorker.

Specified by:

apply in interface GHDirectory

Parameters:

fileWorker - Bearbeitet eine Datei.

printGraph

public final String printGraph()

Description copied from interface: GHEntry

Liefert eine Skizze der Verzeichnisstruktur.

Specified by:

printGraph in interface GHEntry

Returns:

Siehe Beschreibung.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object _directory)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object