de.awtools.homegen.directory

Interface GHEntry

All Known Subinterfaces:

GHDirectory, GHFile, SnippetHtmlFile

All Known Implementing Classes:

AbstractGHDirectory, AbstractGHEntry, AbstractGHFile

public interface GHEntry

Gemeinsame Schnittstelle von GHDirectory und GHFile.

Since:

1.5

Version:

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

Author:

by Andre Winkler, $LastChangedBy: andrewinkler $

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROOT_DIR Kennzeichnung/Name für das Wurzelverzeichnis.

Method Summary

Methods

Modifier and Type	Method and Description
List<GHDirectory>	getDirectoryPath() Liefert den GHDirectory Pfad von der Wurzel bis zu diesem Eintrag.
File	getFile() Liefert das File Objekt für dieses Verzeichnis.
int	getLevelFromRoot() Liefert die Anzahl der cd ..
String	getName() Der Name des Verzeichnisses.
String	getPath() Liefert einen Pfad von der Wurzel bis in dieses Verzeichnis.
boolean	isNewer(GHEntry file) Prüft, ob das übergebene GHEntry ein jüngeres Erstellungsdatum besitzt.
String	printGraph() Liefert eine Skizze der Verzeichnisstruktur.

Field Detail

ROOT_DIR

static final String ROOT_DIR

Kennzeichnung/Name für das Wurzelverzeichnis.

See Also:

Constant Field Values

Method Detail

getName

String getName()

Der Name des Verzeichnisses. Für das Root-Verzeichnis ist das ROOT_DIR.

Returns:

Verzeichnisname.

getPath

String getPath()

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

Returns:

Eine '/' separierte Aufzählung von Verzeichnissen.

getDirectoryPath

List<GHDirectory> getDirectoryPath()

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

Returns:

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

getFile

File getFile()

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

Returns:

Das File Objekt zu diesem Verzeichnis.

isNewer

boolean isNewer(GHEntry file)

Prüft, ob das übergebene GHEntry ein jüngeres Erstellungsdatum besitzt.

Parameters:

file - Mit diesem GHEntry findet der Vergleich statt.

Returns:

Liefert true, wenn das übergebene GHEntry ein jüngeres Erstellungsdatum besitzt.

getLevelFromRoot

int getLevelFromRoot()

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.

Returns:

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

printGraph

String printGraph()

Liefert eine Skizze der Verzeichnisstruktur.

Returns:

Siehe Beschreibung.