okw

Class OKW_FileHelper

java.lang.Object

okw.OKW_FileHelper

public class OKW_FileHelper
extends Object

\~german OKW_FileHelper enthält FilfsMethoden für die Handhabung von Dateien und Verzechnissen.. \~english \~

Author:

Zoltan Hrabovszki \date 2013-12-30

Constructor Summary

Constructors

Constructor and Description
OKW_FileHelper()

Method Summary

Modifier and Type	Method and Description
static String	convertDirectorySeperator(String fpsPath) \~german Konvertiert für das Host-Betriebsystem den Path Separator.
static void	copy(String fpsSource, String fpsDestination, Boolean copySubDirs)
static void	copyDirectory(String fpsSourceFolder, String fpsDestinationFolder)
static Boolean	createEmptyDirectory(String fpsPath) \~german Erzeugt ein leeres Verzechniss mit dem angegebenen Pfad.
static boolean	createFile(String fpsPaFiNa) \~german \brief Legt eine Leere Datei an.
static void	deleteDirectory(String Path) \~german Löschent rekursiv alle Dateien und Unterverzeichnisse und das gegebenen Verzeichniss selbst.
static Boolean	deleteFile(String fpsPaFiNa) \~german Löscht die gegebene Datei _fpsPaFiNa_.
static void	deleteFiles(String fpsPaFiNa) \~german Löscht alle Dateien des gegebenen Musters im gegebenen Verzeichniss Rekursive.
static void	DirectoryCreate(String PATH) \~german Erstellt ein Verzeichnis, einschließlich aller notwendigen, aber nicht vorhandenen übergeordneten Verzeichnisse.
static Boolean	directoryExists(String fpsPaFiNa) \~german Prüft, ob die gegebene _fpsPaFiNa_ Datei existiert.
static Boolean	fileExists(String fpsPaFiNa) \~german \brief Prüft, ob die gegebene _fpsPaFiNa_ Datei existiert.
static Boolean	isDirectoryEmpty(String PATH) \~german Diese Methode prüft, ob das gegebene Verzeichniss existiert und leer ist.
static Boolean	isFile(String PATH) \~german Prüft, ob der gegebene PATH eine Datei ist.
static ArrayList<File>	ListFiles(String fpsPath)
static void	move(String fpsPaFiNaSource, String fpsPaFiNaDestination) \~german Verschiebt die gegeben Quell-Datei zu einer neuen Ziel-Datei.
static boolean	moveDirectory(String fpsPaNaSource, String fpsPaNaDestination) \~german \brief Verzeichniss verschieben löschen des gegebenen Verzeichnisses..

Methods inherited from class java.lang.Object

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

Constructor Detail

OKW_FileHelper

public OKW_FileHelper()

Method Detail

createEmptyDirectory

public static Boolean createEmptyDirectory(String fpsPath)

\~german Erzeugt ein leeres Verzechniss mit dem angegebenen Pfad. Endbedingung: Nachdem Aufruf existiert ein leeres Verzeichniss mit dem gegebenen Pfad. -# Existiert das Verzeichniss nicht, dann wird ein (leeres) Verzeichniss angelegt. -# Existiert das Verzeichniss, dann wird dieser rekursiv gelöscht und neu angelegt.

Parameters:

fpsPath - Pfad des Verzeichnisses, welches Angelegt werden soll.

fpsPath - Path of the directory which is to be created.

Returns:

true wenn ein leeres Verzeichniss erfolgreich angelegt worden ist, sonst false. \~english Creates an empty directory with the specified path. End condition: After call an empty directory exists with the given path. -# If the directory does not exist, an (empty) directory is created. -# If the directory exists, it is deleted recursively and recreated.

deleteDirectory

public static void deleteDirectory(String Path)

\~german Löschent rekursiv alle Dateien und Unterverzeichnisse und das gegebenen Verzeichniss selbst. Endbedingung: Verzeichniss exsitiert einschliesslich aller Dateien und Unterverueichnisse nachdem Aufruf nicht mehr. -# Existiert das Verzeichniss nicht, dann ist die Endbedingung bereits erfüllt. Es wird keine weitere Aktion durchgeführt. Methode wird ohne Fehler beenden. -# Existiert das Verzeichniss, dann wird dieser rekursiv mit dem gesamten Inhalt gelöscht. \param fpsPath \~english \~

directoryExists

public static Boolean directoryExists(String fpsPaFiNa)

\~german Prüft, ob die gegebene _fpsPaFiNa_ Datei existiert. \param fpsPaFiNa PathAndFileName: Angabe des vollständigen Pfades der zulöschenden Datei. \return true, falls die Datei existiert, sonst false. \~english Checks if the given _fpsPaFiNa_ file exists. \param fpsPaFiNa PathAndFileName: Specifies the complete path of the file to be deleted. \return true, if the file exists, otherwise false. \~ \author Zoltan Hrabovszki \date 2013.12.30

copyDirectory

public static void copyDirectory(String fpsSourceFolder,
                                 String fpsDestinationFolder)

moveDirectory

public static boolean moveDirectory(String fpsPaNaSource,
                                    String fpsPaNaDestination)
                             throws IOException,
                                    FileNotFoundException

\~german \brief Verzeichniss verschieben löschen des gegebenen Verzeichnisses.. \param fpsPaNaSource Pfad des Quell-Verzeichnisses. \param fpsPaNaDestination Pfad des Ziel-Verzeichnisses. \~english \~ \author Zoltan Hrabovszki \date 2013.12.30

Throws:

IOException

FileNotFoundException

copy

public static void copy(String fpsSource,
                        String fpsDestination,
                        Boolean copySubDirs)
                 throws IOException,
                        FileNotFoundException

Throws:

IOException

FileNotFoundException

ListFiles

public static ArrayList<File> ListFiles(String fpsPath)

Parameters:

fpsPath -

Returns:

deleteFiles

public static void deleteFiles(String fpsPaFiNa)

\~german Löscht alle Dateien des gegebenen Musters im gegebenen Verzeichniss Rekursive. Die Verzeichnisstruktur bleibt erhalten. https://stackoverflow.com/a/794883 https://www.rgagnon.com/javadetails/java-0072.html \param fpsPaFiNa Pfad und Name der Datei. Wildcards * und ? sind erlaubt. \return \~english \brief \todo TODO: Brief Description. \todo TODO: Detailed Description \param \return \~ \author Zoltán Hrabovszki \date 2015.08.22

deleteFile

public static Boolean deleteFile(String fpsPaFiNa)

\~german Löscht die gegebene Datei _fpsPaFiNa_. Verzeichnisse werden nicht gelöscht. __Anmerkung:__ Existiert die Datei, dann wird diese gelöscht, falls die Datei nicht existiert, dann passiert schlicht nichts weiter. D.h. es wird auch kein Fehler oder eine Exception ausgelöst. Ist die vermeintliche Datei in Wahrheit ein Verzeichniss, dann wird eine OKWFileDoesNotExistsException ausgelöst. \param fpsPaFiNa PathAndFileName: Angabe des vollständigen Pfades der zulöschenden Datei. \~english \~ \author Zoltan Hrabovszki \date 2013.12.30

fileExists

public static Boolean fileExists(String fpsPaFiNa)

\~german \brief Prüft, ob die gegebene _fpsPaFiNa_ Datei existiert. \param fpsPaFiNa PathAndFileName: Vollständiger Pfad der Datein, die auf Existenz Geprüft werden soll. \return true, falls die Datei _fpsPaFiNa_ existiert, sonst false. \~english \~ \author Zoltan Hrabovszki \date 2013.12.30

isFile

public static Boolean isFile(String PATH)

\~german Prüft, ob der gegebene PATH eine Datei ist.

move

public static void move(String fpsPaFiNaSource,
                        String fpsPaFiNaDestination)
                 throws IOException,
                        FileNotFoundException

\~german Verschiebt die gegeben Quell-Datei zu einer neuen Ziel-Datei. \param fpsPaFiNaSource PathAndFileName: Angabe des vollständigen Pfades der zulöschenden Datei. \param fpsPaFiNaDestination Angabe des vollständigen Pfades der zulöschenden Datei. \~english \~ \author Zoltan Hrabovszki \date 2013.12.30

Throws:

IOException

FileNotFoundException

createFile

public static boolean createFile(String fpsPaFiNa)
                          throws IOException

\~german \brief Legt eine Leere Datei an. \param fpsPaFiNa PathAndFileName: Angabe des vollständigen Pfades der an zu legenden Datei. \~english \~ \author Zoltan Hrabovszki \date 2013.12.30

Throws:

IOException

isDirectoryEmpty

public static Boolean isDirectoryEmpty(String PATH)

\~german Diese Methode prüft, ob das gegebene Verzeichniss existiert und leer ist. D.h. das Verzeichniss enthält: -# keine Dateien und -# keine Unterverzeichnisse

Parameters:

PATH - Das zu prüfende Verzeichniss.

PATH - The directory to be checked.

Returns:

true wenn das Verzeichniss leer ist, sonst false

Throws:

OKW.Exceptions.OKWDirectoryDoesNotExistsException - wird ausgelöst, wenn de gegeben Pfad nicht auf ein existierendesVerzeichiss zeigt. \~english This method checks whether the given directory exists and is empty. This means that the directory contains: -# no files and -# no subdirectories

OKW.Exceptions.OKWDirectoryDoesNotExistsException - is raised if the given path does not point to an existing directory. \~

convertDirectorySeperator

public static String convertDirectorySeperator(String fpsPath)

\~german Konvertiert für das Host-Betriebsystem den Path Separator. Je nach Betriebssystem wird wie folgt konvertiert: -# Auf einem Windows/DOS System werden Unix-Pfad-Trenner "/" nach "\" konvertiert. -# Auf einem OSX, Linux (Unix-Artige) Systemen wir der DOS-Pfad Trenner "\" nach "/" konvertiert.

Parameters:

fpsPath - Pfad, der zu konvertieren ist.

fpsPath - Path to convert.

Returns:

Könvertierter Pfad \~english Converts the Path Separator for the host operating system. Depending on the operating system, the conversion is as follows: -# On a Windows/DOS system, Unix path separators "/" are converted to "\". -# On an OSX, Linux (Unix-like) system, the DOS path separator "\" is converted to "/".

DirectoryCreate

public static void DirectoryCreate(String PATH)
                            throws IOException

\~german Erstellt ein Verzeichnis, einschließlich aller notwendigen, aber nicht vorhandenen übergeordneten Verzeichnisse. Wenn eine Datei bereits mit dem angegebenen Namen existiert, aber kein Verzeichnis ist, dann wird eine IOException ausgelöst. Wenn das Verzeichnis nicht erstellt werden kann (oder nicht bereits existiert), wird eine IOException ausgelöst.

Parameters:

PATH - - Verzeichnis, das erstellt werden soll, darf nicht Null sein. \~english Creates a directory, including any necessary but nonexistent parent directories. If a file already exists with specified name but it is not a directory then an IOException is thrown. If the directory cannot be created (or does not already exist) then an IOException is thrown.

PATH - - directory to create, must not be null \~

Throws:

IOException - \date 2019-12-01