de.awtools.homegen.directory.utils

Class GHFileUtils

java.lang.Object

de.awtools.homegen.directory.utils.GHFileUtils

public class GHFileUtils
extends Object

Verschiedene Utilities für das Suchen von Dateien in Verzeichnissen etc.

Version:

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

Author:

by Andre Winkler, $LastChangedBy: andrewinkler $

Constructor Summary

Constructors

Constructor and Description
GHFileUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkDirectory(File dir) Prüft, ob der übergebene File-Parameter ein Verzeichnis und lesbar ist.
static void	checkFile(File file) Prüft, ob der übergebene File-Parameter eine Datei und lesbar ist.
static boolean	copyFile(GHFile file, GHDirectory target, boolean force, GHBuilder builder) Kopiert eine Datei file in das Verzeichnis directory.
static GHDirectory	createPath(List<GHDirectory> path, GHDirectory target, GHBuilder builder) Erstellt den übergebenen Verzeichnispfad im Target-Verzeichnis.
static List<File>	findDeepDirectories(File directory) Fischt aus einem Verzeichnis alle Unterverzeichnisse heraus.
static List<File>	findDirectories(File directory) Wird von der Methode findDeepDirectories(File) verwendet und ermittelt alle Verzeichnisse unterhalb des gesuchten Verzeichnisses.
static GHFile	findFile(GHFile file, GHDirectory directory) Sucht nach einem file in dem Verzeichnis directory.
static GHFile	findFileIgnoreExtension(GHFile file, GHDirectory directory, String expectedExtension) Siehe dazu in der Methode findFile(GHFile, GHDirectory).
static List<File>	findFiles(File directory) Liefert eine Liste von Files aus dem übergebenen Verzeichnis.
static List<File>	findFiles(File directory, org.apache.commons.io.filefilter.SuffixFileFilter suffixFileFilter) Liefert eine Liste von Files aus dem übergebenen Verzeichnis.
static String	removeBaseDir(File baseDir, File fileName) Entfernt aus einem Dateibezeichner den Basispfad.
static String	removeBaseDir(String baseDir, String fileName) Entfernt aus einem Dateibezeichner den Basispfad.
static String	replace(String text, Map<String,String> tokens, String encoding) Ersetzt alle @...@ Ausdrücke durch die entsprechenden Werte.
static void	replaceInFile(File source, Map<String,String> tokens, String encoding) Ersetzt die Tokens '@...@' in der übergebenen Datei.

Methods inherited from class java.lang.Object

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

Constructor Detail

GHFileUtils

public GHFileUtils()

Method Detail

checkDirectory

public static void checkDirectory(File dir)

Prüft, ob der übergebene File-Parameter ein Verzeichnis und lesbar ist.

Parameters:

dir - Das zu prüfende File Objekt.

checkFile

public static void checkFile(File file)

Prüft, ob der übergebene File-Parameter eine Datei und lesbar ist.

Parameters:

file - Das zu prüfende File Objekt.

findFile

public static GHFile findFile(GHFile file,
              GHDirectory directory)

Sucht nach einem file in dem Verzeichnis directory. Das übergebene und das eventuell gefundenen GHFile Objekt müssen nicht im Sinne von == gleich sein. Diese Methode ist sinnvoll bei Verwendung von zwei unterschiedlichen Root-Verzeichnissen, die eine ähnliche Unterstruktur besitzen.

Parameters:

file - Die zu suchende Datei.

directory - Das Verzeichnis und deren Unterverzeichnisse die untersucht werden.

Returns:

Die gefundene Datei oder null wenn nichts gefunden.

findFileIgnoreExtension

public static GHFile findFileIgnoreExtension(GHFile file,
                             GHDirectory directory,
                             String expectedExtension)

Siehe dazu in der Methode findFile(GHFile, GHDirectory). Die Datei-Extension wird bei der Suche ignoriert. Die Dateien müssen nur gleich im Namen sein.

Parameters:

file - Die zu suchende Datei.

directory - Das Verzeichnis und deren Unterverzeichnisse die untersucht werden.

expectedExtension - Die erwartete Erweiterung.

Returns:

Die gefundene Datei oder null wenn nichts gefunden.

copyFile

public static boolean copyFile(GHFile file,
               GHDirectory target,
               boolean force,
               GHBuilder builder)

Kopiert eine Datei file in das Verzeichnis directory. Den relativen Pfad den die Datei file im alten GHDirectory besaß, wird sie im neuen director beibehalten.

Parameters:

file - Die zu kopierende Datei.

target - Das Verzeichnis im dem die Datei kopiert werden soll.

force - Wenn false wird die Kopieraktion nur dann ausgeführt, wenn im Target-Verzeichnis die Datei noch nicht vorhanden ist, oder die zu kopierende Datei ein jüngeres Datum als die Datei im Target-Verzeichnis besitzt.

builder - Erstellt das passende GHDirectory Objekt.

Returns:

Liefert true zurück, wenn die Datei kopiert wurde. In allen anderen Fällen wird false zurück geliefert.

createPath

public static GHDirectory createPath(List<GHDirectory> path,
                     GHDirectory target,
                     GHBuilder builder)

Erstellt den übergebenen Verzeichnispfad im Target-Verzeichnis. Die etwaigen Dateien die im übergebenen Verzeichnispfad hängen, werden nicht angelegt.

Parameters:

path - Der anzulegende Pfad.

target - Das Target-Root-Verzeichnis. In diesem werden ggf. die fehlenden Pfade nachgetragen.

builder - Erstellt das passende GHDirectory Objekt.

Returns:

Das letzte angelegte Verzeichnis.

removeBaseDir

public static String removeBaseDir(File baseDir,
                   File fileName)

Entfernt aus einem Dateibezeichner den Basispfad. Zum Beispiel: Basis=C:\temp\test und Dateiname=C:\temp\test\dir\subdir\test.txt. Dann liefert die Methode dir/subdir/test.txt zurück.

Parameters:

baseDir - Das Basisverzeichnis.

fileName - Die Datei.

Returns:

Ein relative Pfad zum Basisverzeichnis.

removeBaseDir

public static String removeBaseDir(String baseDir,
                   String fileName)

Entfernt aus einem Dateibezeichner den Basispfad. Zum Beispiel: Basis=C:\temp\test und Dateiname=C:\temp\test\dir\subdir\test.txt. Dann liefert die Methode dir/subdir/test.txt zurück.
HINWEIS: Die Pfad- und Dateiangaben müssen in kanonischer Form vorliegen. Das Endergebnis der Operation wird normalisiert! Siehe dazu WinFileUtils#normalizePath(java.lang.String).

Parameters:

baseDir - Das Basisverzeichnis.

fileName - Die Datei.

Returns:

Ein relativer Pfad zum Basisverzeichnis.

findFiles

public static List<File> findFiles(File directory,
                   org.apache.commons.io.filefilter.SuffixFileFilter suffixFileFilter)

Liefert eine Liste von Files aus dem übergebenen Verzeichnis.

Parameters:

directory - Das zu untersuchende Verzeichnis.

suffixFileFilter - Ein Filter. Nur diese Dateien landen in der Ergebnisliste.

Returns:

Die Files in diesem Verzeichnis.

See Also:

findFiles(File)

findFiles

public static List<File> findFiles(File directory)

Liefert eine Liste von Files aus dem übergebenen Verzeichnis.

Parameters:

directory - Das Ausgangsverzeichnis.

Returns:

Die gefundenen Dateien.

See Also:

findFiles(File, SuffixFileFilter)

findDirectories

public static List<File> findDirectories(File directory)

Wird von der Methode findDeepDirectories(File) verwendet und ermittelt alle Verzeichnisse unterhalb des gesuchten Verzeichnisses.

Parameters:

directory - Das Ausgangsverzeichnis.

Returns:

Die gefundenen Unterverzeichnisse.

findDeepDirectories

public static List<File> findDeepDirectories(File directory)

Fischt aus einem Verzeichnis alle Unterverzeichnisse heraus.

Parameters:

directory - Das zu untersuchende Verzeichnis.

Returns:

Die gefundenen Unterverzeichnisse.

replaceInFile

public static void replaceInFile(File source,
                 Map<String,String> tokens,
                 String encoding)

Ersetzt die Tokens '@...@' in der übergebenen Datei. Das Datum 'lastModified' wird dabei nicht verändert. Nach der Filter-Operations wird dieses wieder auf den alten Wert gesetzt.

Parameters:

source - Die zu untersuchende Datei.

tokens - Die Tokens.

encoding - Sollte i.d.R. UTF-8 oder ISO-8859-1 sein.

replace

public static String replace(String text,
             Map<String,String> tokens,
             String encoding)

Ersetzt alle @...@ Ausdrücke durch die entsprechenden Werte.

Parameters:

text - Der Text

tokens - Die Tokens mit der Ersetzung.

encoding - Sollte i.d.R. UTF-8 oder ISO-8859-1 sein.

Returns:

Das Endergebnis.