okw.OKW_FileHelper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
Show all versions of core Show documentation
This is the core-module of OpenKeyWord. This module is automatically integrated by the adapters. In GUI automation, the core module is automatically integrated by the GUI modules (dependencies).
/*
==============================================================================
Author: Zoltán Hrabovszki
Copyright © 2012 - 2019 IT-Beratung Hrabovszki
www.OpenKeyWord.de
==============================================================================
This file is part of OpenKeyWord.
OpenKeyWord is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenKeyWord is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with OpenKeyWord. If not, see ListFiles( String fpsPath )
{
ArrayList lvReturn = new ArrayList();
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;
}
/**
* \~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
*/
public static void deleteFiles( String fpsPaFiNa )
{
if ( directoryExists( fpsPaFiNa ) )
{
File myDir = new File( fpsPaFiNa );
File[] listOfFiles = myDir.listFiles();
for ( File myFileToDelete : listOfFiles )
{
if ( !myFileToDelete.isDirectory() )
{
myFileToDelete.delete();
}
}
}
}
/**
* \~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
* */
public static Boolean deleteFile( String fpsPaFiNa )
{
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;
}
/**
* \~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
*/
public static Boolean fileExists( String fpsPaFiNa )
{
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;
}
/** \~german
* Prüft, ob der gegebene PATH eine Datei ist.
*
* @info Die Datei muss existieren, sonst wird hier
*
* \param PATH Pfad der geprüft werden soll, ob dieser eine Datei ist.
* \return true, falls der Pfad eine Datei ist, sonst false.
*
* \~english
* Verifies that the given PATH is a file.
*
* \param PATH Path to check if it is a file.
* \return true, if the path is a file, otherwise false.
*
* \~
* \author Zoltan Hrabovszki
* \date 2019-12-01
*/
public static Boolean isFile( String PATH )
{
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;
}
/** \~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
*/
public static void move( String fpsPaFiNaSource, String fpsPaFiNaDestination ) throws IOException, FileNotFoundException
{
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();
}
}
/** \~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
*/
public static boolean createFile( String fpsPaFiNa ) throws IOException
{
Boolean lvbReturn = false;
Path newFilePath = Paths.get( fpsPaFiNa );
try
{
if ( !Files.exists( newFilePath ) )
{
Files.createFile( newFilePath );
}
}
finally
{
Log.LogFunctionEnd( lvbReturn );
}
return lvbReturn;
}
/** \~german
* Diese Methode prüft, ob das gegebene Verzeichniss existiert und leer ist.
* D.h. das Verzeichniss enthält:
*
* -# keine Dateien und
* -# keine Unterverzeichnisse
*
* @param PATH Das zu prüfende Verzeichniss.
* @return true wenn das Verzeichniss leer ist, sonst false
*
* @exception 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
*
* @param PATH The directory to be checked.
* @return true, if the directory is empty, otherwise false
*
* @exception OKW.Exceptions.OKWDirectoryDoesNotExistsException is raised if the given path does not point to an existing directory.
* \~
* @author Zoltan Hrabovszki
* @date 2013-12-30
*/
public static Boolean isDirectoryEmpty( String PATH )
{
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;
}
/** \~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.
*
* @param fpsPath Pfad, der zu konvertieren ist.
* @return 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 "/".
*
* @param fpsPath Path to convert.
* @return Converted path.
*
* \~
* @author Zoltan Hrabovszki
* @date 2013.12.30
*/
public static String convertDirectorySeperator( String fpsPath )
{
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;
}
/**
* \~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.
*
* @param 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.
*
* @param PATH - directory to create, must not be null
* \~
* @author Zoltán Hrabovszki
* @throws IOException
* @date 2019-12-01
*/
public static void DirectoryCreate( String PATH ) throws IOException
{
File myFile = new File( PATH );
Log.LogFunctionStartDebug( "OKW_FileHelper.CreateDirectory", "PATH", PATH );
try
{
org.apache.commons.io.FileUtils.forceMkdir( myFile );
}
finally
{
Log.LogFunctionEndDebug();
}
}
}