OKW_FileHelper enthält FilfsMethoden für die Handhabung von Dateien und Verzechnissen. Mehr ...

Zusammengehörigkeiten von okw.OKW_FileHelper:

Öffentliche, statische Methoden
static Boolean	createEmptyDirectory (String fpsPath)

static void	deleteDirectory (String Path)
	Löschent rekursiv alle Dateien und Unterverzeichnisse und das gegebenen Verzeichniss selbst. Mehr ...

static Boolean	directoryExists (String fpsPaFiNa)
	Prüft, ob die gegebene fpsPaFiNa Datei existiert. Mehr ...

static void	copyDirectory (String fpsSourceFolder, String fpsDestinationFolder)

static boolean	moveDirectory (String fpsPaNaSource, String fpsPaNaDestination) throws IOException, FileNotFoundException
	Verzeichniss verschieben löschen des gegebenen Verzeichnisses. Mehr ...

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

static ArrayList< File >	ListFiles (String fpsPath)

static void	deleteFiles (String fpsPaFiNa)
	Löscht alle Dateien des gegebenen Musters im gegebenen Verzeichniss Rekursive. Mehr ...

static Boolean	deleteFile (String fpsPaFiNa)
	Löscht die gegebene Datei fpsPaFiNa. Mehr ...

static Boolean	fileExists (String fpsPaFiNa)
	Prüft, ob die gegebene fpsPaFiNa Datei existiert. Mehr ...

static Boolean	isFile (String PATH)
	Prüft, ob der gegebene PATH eine Datei ist. Mehr ...

static void	move (String fpsPaFiNaSource, String fpsPaFiNaDestination) throws IOException, FileNotFoundException
	Verschiebt die gegeben Quell-Datei zu einer neuen Ziel-Datei. Mehr ...

static boolean	createFile (String fpsPaFiNa) throws IOException
	Legt eine Leere Datei an. Mehr ...

static Boolean	isDirectoryEmpty (String PATH)
	Diese Methode prüft, ob das gegebene Verzeichniss existiert und leer ist. Mehr ...

static String	convertDirectorySeperator (String fpsPath)
	Konvertiert für das Host-Betriebsystem den Path Separator. Mehr ...

static void	DirectoryCreate (String PATH) throws IOException
	Erstellt ein Verzeichnis, einschließlich aller notwendigen, aber nicht vorhandenen übergeordneten Verzeichnisse. Mehr ...

Private, statische Methoden
static boolean	copyDirectory (File fpSourceFolder, File fpDestinationFolder)

Statische, private Attribute
static Logger_Sngltn	Log = Logger_Sngltn.getInstance()
	Instanz der Zentralen Loggerklasse. Mehr ...

Ausführliche Beschreibung

OKW_FileHelper enthält FilfsMethoden für die Handhabung von Dateien und Verzechnissen.

Autor: Zoltan Hrabovszki

Datum: 2013-12-30

Definiert in Zeile 63 der Datei OKW_FileHelper.java.

Dokumentation der Elementfunktionen

◆ convertDirectorySeperator()

static String okw.OKW_FileHelper.convertDirectorySeperator ( String fpsPath )

static

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.

Parameter

fpsPath Pfad, der zu konvertieren ist.

Rückgabe: Könvertierter Pfad

Autor: Zoltan Hrabovszki

Datum: 2013.12.30

Definiert in Zeile 778 der Datei OKW_FileHelper.java.

     {
         String lvsReturn = fpsPath;
  
         Log.LogFunctionStartDebug( "OKW_FileHelper.ConvertDirectorySeperator", "fpsPath", fpsPath );
  
         try
         {
             String myFileSeparator = System.getProperty( "file.separator" );
  
             if ( "/".equals( myFileSeparator ) )
             {
                 lvsReturn = fpsPath.replace( "\\", "/" );
             }
             else if ( "\\".equals( myFileSeparator ) )
             {
                 lvsReturn = fpsPath.replace( "/", "\\" );
             }
             else
                 throw ( new OKWDirectorySeperatorNotImplementedException( "Error: Unknown file.separator: -" + myFileSeparator + "-" ) );
  
             lvsReturn = lvsReturn.replace( "\\C:", "C:" );
         }
         finally
         {
             Log.LogFunctionEndDebug( lvsReturn );
         }
  
         return lvsReturn;
     }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ createEmptyDirectory()

static Boolean okw.OKW_FileHelper.createEmptyDirectory ( String fpsPath )

static

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.

Parameter

fpsPath Pfad des Verzeichnisses, welches Angelegt werden soll.

Rückgabe: true wenn ein leeres Verzeichniss erfolgreich angelegt worden ist, sonst false.

Autor: Zoltan Hrabovszki

Datum: 2013-12-30

Definiert in Zeile 110 der Datei OKW_FileHelper.java.

     {
  
         String lvsPath = "";
         Boolean lvbReturn = false;
  
         try
         {
             // lvsPath = MyParser.ParseMe(fpsPath);
             Log.LogFunctionStart( "DirectoryCreateEmpty", "String", fpsPath );
  
             File myDirectory = new File( fpsPath );
  
             // Determine whether the directory exists.
             if ( myDirectory.exists() & myDirectory.isDirectory() )
             {
                 deleteDirectory( lvsPath );
             }
             else if ( myDirectory.exists() & myDirectory.isFile() )
             {
                 deleteFile( lvsPath );
             }
  
             // Try to create the directory.
             myDirectory.mkdirs();
  
             lvbReturn = true;
  
         }
         catch (Exception e)
         {
             Log.LogPrint( "The process failed:" );
         }
         finally
         {
             Log.LogFunctionEnd( lvbReturn );
         }
         return lvbReturn;
     }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ createFile()

static boolean okw.OKW_FileHelper.createFile ( String fpsPaFiNa ) throws IOException

static

Legt eine Leere Datei an.

Parameter

fpsPaFiNa PathAndFileName: Angabe des vollständigen Pfades der an zu legenden Datei.

Autor: Zoltan Hrabovszki

Datum: 2013.12.30

Definiert in Zeile 676 der Datei OKW_FileHelper.java.

     {
  
         Boolean lvbReturn = false;
  
         Path newFilePath = Paths.get( fpsPaFiNa );
         
         try
         {
  
             if ( !Files.exists( newFilePath ) )
             {
                 Files.createFile( newFilePath );
             }
         }
         finally
         {
             Log.LogFunctionEnd( lvbReturn );
         }
  
         return lvbReturn;
  
     }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ deleteDirectory()

static void okw.OKW_FileHelper.deleteDirectory ( String Path )

static

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.

Parameter

fpsPath

Autor: Zoltan Hrabovszki

Datum: 2013-12-30

Definiert in Zeile 168 der Datei OKW_FileHelper.java.

     {
         String lvsPath = Path;
         Boolean lvbReturn = false;
  
         Log.LogFunctionStartDebug( "OKW_Helper.DirectoryDelete", "Path", Path );
  
         try
         {
  
             // \todo TODO: ANTLR-Paser einschalten
             // lvsPaFiNa = MyParser.ParseMe(lvsPaFiNa);
  
             File myPath = new File( lvsPath );
  
             if ( myPath.exists() )
             {
                 for ( File f : myPath.listFiles() )
                 {
                     if ( f.isDirectory() )
                     {
                         deleteDirectory( f.getPath() );
                         f.delete();
                     }
                     else
                     {
                         f.delete();
                     }
                 }
                 myPath.delete();
             }
         }
         finally
         {
             Log.LogFunctionEndDebug( lvbReturn );
         }
     }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ deleteFile()

static Boolean okw.OKW_FileHelper.deleteFile ( String fpsPaFiNa )

static

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.

Parameter

fpsPaFiNa PathAndFileName: Angabe des vollständigen Pfades der zulöschenden Datei.

Autor: Zoltan Hrabovszki

Datum: 2013.12.30

Definiert in Zeile 496 der Datei OKW_FileHelper.java.

     {
         Boolean lvbReturn = false;
  
         Log.LogFunctionStartDebug( "OKW_FileHelper.FileDelete", "fpsPaFiNa", fpsPaFiNa );
  
         if ( fileExists( fpsPaFiNa ) )
         {
             try
             {
                 File myFile = new File( fpsPaFiNa );
  
                 lvbReturn = myFile.delete();
             }
             finally
             {
                 Log.LogFunctionEndDebug();
             }
         }
  
         return lvbReturn;
     }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ deleteFiles()

static void okw.OKW_FileHelper.deleteFiles ( String fpsPaFiNa )

static

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

Parameter

fpsPaFiNa Pfad und Name der Datei. Wildcards * und ? sind erlaubt.

Rückgabe

Autor: Zoltán Hrabovszki

Datum: 2015.08.22

Definiert in Zeile 461 der Datei OKW_FileHelper.java.

     {
  
         if ( directoryExists( fpsPaFiNa ) )
         {
             File myDir = new File( fpsPaFiNa );
             File[] listOfFiles = myDir.listFiles();
  
             for ( File myFileToDelete : listOfFiles )
             {
                 if ( !myFileToDelete.isDirectory() )
                 {
                     myFileToDelete.delete();
                 }
             }
         }
     }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ DirectoryCreate()

static void okw.OKW_FileHelper.DirectoryCreate ( String PATH ) throws IOException

static

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.

Parameter

PATH	- Verzeichnis, das erstellt werden soll, darf nicht Null sein.

Autor: Zoltán Hrabovszki

Ausnahmebehandlung

IOException

Datum: 2019-12-01

Definiert in Zeile 829 der Datei OKW_FileHelper.java.

     {
         File myFile = new File( PATH );
  
         Log.LogFunctionStartDebug( "OKW_FileHelper.CreateDirectory", "PATH", PATH );
  
         try
         {
             org.apache.commons.io.FileUtils.forceMkdir( myFile );
         }
         finally
         {
             Log.LogFunctionEndDebug();
         }
     }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ directoryExists()

static Boolean okw.OKW_FileHelper.directoryExists ( String fpsPaFiNa )

static

Prüft, ob die gegebene fpsPaFiNa Datei existiert.

Parameter

fpsPaFiNa PathAndFileName: Angabe des vollständigen Pfades der zulöschenden Datei.

Rückgabe: true, falls die Datei existiert, sonst false.

Autor: Zoltan Hrabovszki

Datum: 2013.12.30

Definiert in Zeile 222 der Datei OKW_FileHelper.java.

     {
         Boolean lvbReturn = false;
  
         Log.LogFunctionStartDebug( "OKW_FileHelper.DirectoryExists", "fpsPaFiNa", fpsPaFiNa );
  
         try
         {
             // \todo TODO: ANTLR-Paser einschalten
             // lvsPaFiNa = MyParser.ParseMe(lvsPaFiNa);
  
             File myFile = new File( fpsPaFiNa );
  
             // Existiert "fpsPaFiNa"?
             if ( myFile.exists() )
             {
                 // Ist ein Verzeichniss?
                 if ( myFile.isDirectory() )
                 {
                     lvbReturn = true;
                 }
                 // Ist es eine Datei?
                 else if ( myFile.isFile() )
                 {
                     throw ( new OKWFileDoesNotExistsException( "This is not a directory! Given path is a directory!" ) );
                 }
                 // Dann Existiert "fpsPaFiNa" nicht!
                 else
                 {
                     lvbReturn = false;
                 }
             }
         }
         finally
         {
             Log.LogFunctionEndDebug( lvbReturn );
         }
  
         return lvbReturn;
     }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ fileExists()

static Boolean okw.OKW_FileHelper.fileExists ( String fpsPaFiNa )

static

Prüft, ob die gegebene fpsPaFiNa Datei existiert.

Parameter

fpsPaFiNa PathAndFileName: Vollständiger Pfad der Datein, die auf Existenz Geprüft werden soll.

Rückgabe: true, falls die Datei fpsPaFiNa existiert, sonst false.

Autor: Zoltan Hrabovszki

Datum: 2013.12.30

Definiert in Zeile 532 der Datei OKW_FileHelper.java.

     {
  
         Boolean lvbReturn = false;
  
         Log.LogFunctionStartDebug( "OKW_FileHelper.FileExist", "fpsPaFiNa", fpsPaFiNa );
  
         try
         {
             File myFile = new File( fpsPaFiNa );
  
             // Existiert "fpsPaFiNa"?
             if ( myFile.exists() )
             {
                 // Ist es eine Datei?
                 if ( myFile.isFile() )
                 {
                     lvbReturn = true;
                 }
                 // Ist ein Verzeichniss?
                 else if ( myFile.isDirectory() )
                 {
                     throw ( new OKWFileDoesNotExistsException( "This is not a file! Given path is a directory!" ) );
                 }
                 // Dann Existiert "fpsPaFiNa" nicht!
                 else
                 {
                     lvbReturn = false;
                 }
             }
         }
         finally
         {
             Log.LogFunctionEndDebug( lvbReturn.toString() );
         }
  
         return lvbReturn;
     }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ isDirectoryEmpty()

static Boolean okw.OKW_FileHelper.isDirectoryEmpty ( String PATH )

static

Diese Methode prüft, ob das gegebene Verzeichniss existiert und leer ist.

D.h. das Verzeichniss enthält:

keine Dateien und
keine Unterverzeichnisse

Parameter

PATH	Das zu prüfende Verzeichniss.

Rückgabe: true wenn das Verzeichniss leer ist, sonst false

Ausnahmebehandlung

OKW.Exceptions.OKWDirectoryDoesNotExistsException wird ausgelöst, wenn de gegeben Pfad nicht auf ein existierendesVerzeichiss zeigt.

Autor: Zoltan Hrabovszki

Datum: 2013-12-30

Definiert in Zeile 727 der Datei OKW_FileHelper.java.

     {
  
         Boolean lvbReturn = false;
         Log.LogFunctionStart( "OKW_FileHelper.IsDirectoryEmpty", "PATH", PATH );
         try
         {
             if ( directoryExists( PATH ) )
             {
                 lvbReturn = Paths.get( PATH ).toFile().listFiles().length == 0;
             }
             else
             {
                 // \todo TODO: Meldung in LM_OKW_FileHelper.xml auslagern...
                 throw new OKWDirectoryDoesNotExistsException( "Directory Does not Exists..." );
             }
         }
         finally
         {
             Log.LogFunctionEnd( lvbReturn );
         }
  
         return false;
     }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ isFile()

static Boolean okw.OKW_FileHelper.isFile ( String PATH )

static

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

@info Die Datei muss existieren, sonst wird hier

Parameter

PATH	Pfad der geprüft werden soll, ob dieser eine Datei ist.

Rückgabe: true, falls der Pfad eine Datei ist, sonst false.

Autor: Zoltan Hrabovszki

Datum: 2019-12-01

Definiert in Zeile 589 der Datei OKW_FileHelper.java.

     {
  
         Boolean lvbReturn = false;
  
         Log.LogFunctionStartDebug( "OKW_FileHelper.isFile", "PATH", PATH );
  
         try
         {
             File myFile = new File( PATH );
  
             // Existiert "fpsPaFiNa"?
             if ( myFile.exists() )
             {
                 // Ist es eine Datei?
                 if ( myFile.isFile() )
                 {
                     lvbReturn = true;
                 }
                 else
                 {
                     lvbReturn = false;
                 }
             }
             else
                 throw ( new OKWFileDoesNotExistsException( "This is not a file! Given path is a directory!" ) );
         }
         finally
         {
             Log.LogFunctionEndDebug( lvbReturn.toString() );
         }
  
         return lvbReturn;
     }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ ListFiles()

static ArrayList<File> okw.OKW_FileHelper.ListFiles ( String fpsPath )

static

Parameter

fpsPath

Rückgabe

Definiert in Zeile 406 der Datei OKW_FileHelper.java.

     {
         ArrayList<File> lvReturn = new ArrayList<File>();
  
         File root = new File( fpsPath );
         File[] list = root.listFiles();
  
         if ( list != null )
         {
             ;
  
             for ( File f : list )
             {
                 if ( f.isDirectory() )
                 {
                     System.out.println( " Dir:" + f.getAbsolutePath() );
                     ListFiles( f.getAbsolutePath() );
                 }
                 else
                 {
                     String myPathy = f.getAbsolutePath();
                     Log.LogPrint( "File:" + myPathy );
                     lvReturn.add( f );
                 }
             }
         }
  
         return lvReturn;
     }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ move()

static void okw.OKW_FileHelper.move	(	String	fpsPaFiNaSource,
		String	fpsPaFiNaDestination
	)		throws IOException, FileNotFoundException

static

Verschiebt die gegeben Quell-Datei zu einer neuen Ziel-Datei.

Parameter

fpsPaFiNaSource	PathAndFileName: Angabe des vollständigen Pfades der zulöschenden Datei.
fpsPaFiNaDestination	Angabe des vollständigen Pfades der zulöschenden Datei.

Autor: Zoltan Hrabovszki

Datum: 2013.12.30

Definiert in Zeile 637 der Datei OKW_FileHelper.java.

     {
  
         Log.LogFunctionStartDebug( "OKW_FileHelper.Move", "fpsPaFiNaSource", fpsPaFiNaSource, "fpsPaFiNaDestination", fpsPaFiNaDestination );
         try
         {
             if ( fileExists( fpsPaFiNaSource ) )
             {
  
                 deleteFile( fpsPaFiNaDestination );
                 copy( fpsPaFiNaSource, fpsPaFiNaDestination, true );
                 deleteFile( fpsPaFiNaSource );
  
             }
             else
             {
                 // \todo TODO: Log in xml-datei auslagern
                 Log.LogFunctionEnd();
                 throw new OKWFileDoesNotExistsException( "file doesnot exists..." );
             }
         }
         finally
         {
             Log.LogFunctionEnd();
         }
     }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ moveDirectory()

static boolean okw.OKW_FileHelper.moveDirectory	(	String	fpsPaNaSource,
		String	fpsPaNaDestination
	)		throws IOException, FileNotFoundException

static

Verzeichniss verschieben löschen des gegebenen Verzeichnisses.

Parameter

fpsPaNaSource	Pfad des Quell-Verzeichnisses.
fpsPaNaDestination	Pfad des Ziel-Verzeichnisses.

Autor: Zoltan Hrabovszki

Datum: 2013.12.30

Definiert in Zeile 347 der Datei OKW_FileHelper.java.

     {
         Boolean lvbReturn = false;
  
         String lvsPaNaSource = fpsPaNaSource;
         String lvsPaNaDestination = fpsPaNaDestination;
  
         try
         {
             // \todo TODO: ANTLR-Paser einschalten
             // lvsPaNaSource = MyParser.ParseMe(fpsPaNaSource);
             // lvsPaNaDestination = MyParser.ParseMe(fpsPaNaDestination);
  
             Log.LogFunctionStartDebug( "OKW_FileHelper.DirectoryMove", "fpsPaNaSource", fpsPaNaSource, "fpsPaNaDestination", fpsPaNaDestination );
  
             if ( directoryExists( lvsPaNaSource ) )
             {
                 // Löschen des ZIEL-verzeichnissen wenn vorhanden
                 deleteDirectory( lvsPaNaDestination );
  
                 // Copy with subfolders
                 copy( lvsPaNaSource, lvsPaNaDestination, true );
  
                 // Delete Source
                 deleteDirectory( lvsPaNaSource );
  
                 lvbReturn = true;
             }
         }
         finally
         {
             Log.LogFunctionEndDebug( lvbReturn );
         }
  
         return lvbReturn;
     }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Dokumentation der Datenelemente

◆ Log

Logger_Sngltn okw.OKW_FileHelper.Log = Logger_Sngltn.getInstance()

staticprivate

Instanz der Zentralen Loggerklasse.

Autor: Zoltan Hrabovszki

Datum: 2017-07-06

Definiert in Zeile 74 der Datei OKW_FileHelper.java.

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

/home/travis/build/Hrabovszki1023/OKW/core/src/main/java/okw/OKW_FileHelper.java

Öffentliche, statische Methoden

Private, statische Methoden

Statische, private Attribute

Ausführliche Beschreibung

Dokumentation der Elementfunktionen

◆ convertDirectorySeperator()

◆ createEmptyDirectory()

◆ createFile()

◆ deleteDirectory()

◆ deleteFile()

◆ deleteFiles()

◆ DirectoryCreate()

◆ directoryExists()

◆ fileExists()

◆ isDirectoryEmpty()

◆ isFile()

◆ ListFiles()

◆ move()

◆ moveDirectory()

Dokumentation der Datenelemente

◆ Log