de.awtools.homegen.directory.utils

Class AbstractGHFile

java.lang.Object

de.awtools.homegen.directory.utils.AbstractGHEntry

de.awtools.homegen.directory.utils.AbstractGHFile

All Implemented Interfaces:

GHEntry, GHFile

public abstract class AbstractGHFile
extends AbstractGHEntry
implements GHFile

Utility Klasse für GHFile Implementierungen.

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	AbstractGHFile(File _file, GHDirectory _directory, String _name) Konstruktor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object _object)
GHDirectory	getDirectory() Liefert das zugeordnete Verzeichnis.
List<GHDirectory>	getDirectoryPath() Liefert den GHDirectory Pfad von der Wurzel bis zu diesem Eintrag.
String	getExtension() Liefert die Extension der Datei, d.h. alles was nach dem letzten '.'
File	getFile() Liefert das File Objekt für dies Datei.
FileType	getFileType() Liefert den Dateityp.
int	getLevelFromRoot() Liefert die Anzahl der cd ..
String	getName() Der Name für die Datei.
String	getNameAndPath() Liefert den Name plus den Verzeichnispfad von der Wurzel an abwärts.
String	getNameWithoutExtension() Liefert den Namen der Datei ohne Extension, d.h. der Name ohne den Zusatz, der nach '.' erscheint.
String	getPath() Liefert den Pfad für diese Datei.
int	hashCode()
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

AbstractGHFile

protected AbstractGHFile(File _file,
              GHDirectory _directory,
              String _name)

Konstruktor.

Parameters:

_file - Die zugeordnete Datei.

_directory - Das zugeordnete Verzeichnis.

_name - Der Name für die zugeordnete Datei.

Method Detail

getName

public final String getName()

Der Name für die Datei.

Specified by:

getName in interface GHEntry

Returns:

Dateiname.

getPath

public final String getPath()

Liefert den Pfad für diese Datei. An dem Pfad ist nicht der Dateiname angehangen. Dafür ist getNameAndPath() zu verwenden.

Specified by:

getPath in interface GHEntry

Returns:

Eine '/' separierte Aufzählung von Verzeichnissen.

See Also:

GHEntry.getPath()

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.

getNameAndPath

public final String getNameAndPath()

Liefert den Name plus den Verzeichnispfad von der Wurzel an abwärts.

Specified by:

getNameAndPath in interface GHFile

Returns:

Datei und Pfadname.

getNameWithoutExtension

public final String getNameWithoutExtension()

Liefert den Namen der Datei ohne Extension, d.h. der Name ohne den Zusatz, der nach '.' erscheint.

Specified by:

getNameWithoutExtension in interface GHFile

Returns:

Der Name der Datei ohne Extension.

getExtension

public final String getExtension()

Liefert die Extension der Datei, d.h. alles was nach dem letzten '.' im Namen steht.

Specified by:

getExtension in interface GHFile

Returns:

Die Datei-Extension.

getFile

public final File getFile()

Liefert das File Objekt für dies Datei. 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 dieser Datei.

getDirectory

public final GHDirectory getDirectory()

Liefert das zugeordnete Verzeichnis.

Specified by:

getDirectory in interface GHFile

Returns:

Das zugeordnete Verzeichnis.

getFileType

public final FileType getFileType()

Liefert den Dateityp.

Specified by:

getFileType in interface GHFile

Returns:

Der Dateityp.

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:

Die Anzahl der Verzeichnisstufen bis in das Wurzelverzeichnis.

See Also:

GHEntry.getLevelFromRoot()

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 _object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object