FileUtils (java-utils 1.1.3 API)

java.lang.Object
- pl.jalokim.utils.file.FileUtils

public final class FileUtils
extends Object

Useful class for Files.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`appendAllElementsAsLinesToFile(String filePath, List<String> elementToWrite)` It append all list element to file, every as separated line.
`static void`	`appendAllElementsAsLinesToFile(String filePath, List<String> elementToWrite, Charset charset)` It append all list element to file, every as separated line.
`static void`	`appendToFile(String filePath, String fileContent)` Append some text to file.
`static void`	`appendToFile(String filePath, String fileContent, Charset charset)` Append some text to file.
`static void`	`consumeEveryLineFromFile(String path, Consumer<String> consumerLine)` It read all lines line by line and put line value to consumerLine argument.
`static void`	`consumeEveryLineFromFile(String path, Consumer<String> consumerLine, Charset charset)` It read all lines line by line and put line value to consumerLine argument.
`static void`	`consumeEveryLineWitNumberFromFile(String path, BiConsumer<Long,String> consumerLineIndex)` It read all lines line by line and put line value to consumerLine argument.
`static void`	`consumeEveryLineWitNumberFromFile(String path, BiConsumer<Long,String> consumerLineIndex, Charset charset)` It read all lines line by line and put line value to consumerLine argument.
`static void`	`createDirectories(String folderPath)` It creates directories recursively, all path part will be a folder type.
`static void`	`createDirectoriesForFile(String pathToFile)` It creates directories recursively, leaf of provided path is expected as file name.
`static void`	`deleteFileOrDirectory(File file)` It removes whole directory or file.
`static void`	`deleteFileOrDirectory(Path path)` It removes whole directory or file.
`static void`	`deleteFileOrDirectory(String pathAsText)` It removes whole directory or file.
`static List<File>`	`listOfFiles(File rootFile)` It returns simple list of files.
`static List<File>`	`listOfFiles(File rootFile, FileFilter fileFilter)` It returns list of files which were filtered by fileFilter.
`static List<File>`	`listOfFiles(Path path)` It returns simple list of files.
`static List<File>`	`listOfFiles(Path path, FileFilter fileFilter)` It returns list of files which were filtered by fileFilter.
`static List<File>`	`listOfFiles(String pathToFile)` It returns simple list of files.
`static List<File>`	`listOfFiles(String pathToFile, FileFilter fileFilter)` It returns list of files which were filtered by fileFilter.
`static String`	`loadFileFromClassPathAsText(String path)` It read from file from classpath and put all content to String.
`static String`	`loadFileFromClassPathAsText(String path, Charset charset)` It read from file from classpath and put all content to String with certain encoding.
`static String`	`loadFileFromPathAsText(File file)` It read from file and put all content to String.
`static String`	`loadFileFromPathAsText(File file, Charset charset)` It read from file and put all content to String with certain encoding.
`static String`	`loadFileFromPathAsText(Path path)` It read from file and put all content to String with certain encoding.
`static String`	`loadFileFromPathAsText(Path path, Charset charset)` It read from file and put all content to String with certain encoding.
`static String`	`loadFileFromPathAsText(String path)` It read from file and put all content to String.
`static String`	`loadFileFromPathAsText(String path, Charset charset)` It read from file and put all content to String with certain encoding.
`static List<String>`	`loadFileFromPathToList(String path)` It reads all lines to list from certain path from system for file.
`static List<String>`	`loadFileFromPathToList(String path, Charset charset)` It reads all lines to list from certain path from system for file.
`static FileCursor`	`readFileFromPathToFileCursor(String path)` It create instance of FileCursor.
`static FileCursor`	`readFileFromPathToFileCursor(String path, Charset charset)` It create instance of FileCursor.
`static void`	`writeAllElementsAsLinesToFile(String filePath, List<String> elementToWrite)` It writes all list element to file, every as separated line.
`static void`	`writeAllElementsAsLinesToFile(String filePath, List<String> elementToWrite, Charset charset)` It writes all list element to file, every as separated line.
`static void`	`writeToFile(File filePath, String fileContent)` It override current file content if exists.
`static void`	`writeToFile(File filePath, String fileContent, Charset charset)` It override current file content if exists.
`static void`	`writeToFile(Path filePath, String fileContent)` It override current file content if exists.
`static void`	`writeToFile(Path filePath, String fileContent, Charset charset)` It override current file content if exists.
`static void`	`writeToFile(String filePath, String fileContent)` It override current file content if exists.
`static void`	`writeToFile(String filePath, String fileContent, Charset charset)` It override current file content if exists.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - loadFileFromPathAsText
```
public static String loadFileFromPathAsText(String path)
```
    It read from file and put all content to String.
    
    Parameters:
    
    path - to file
    
    Returns:
    
    text with file content
  - loadFileFromPathAsText
```
public static String loadFileFromPathAsText(String path,
                                            Charset charset)
```
    It read from file and put all content to String with certain encoding.
    
    Parameters:
    
    path - to file
    
    charset - instance of java.nio.charset.Charset
    
    Returns:
    
    text with file content
  - loadFileFromPathAsText
```
public static String loadFileFromPathAsText(File file)
```
    It read from file and put all content to String.
    
    Parameters:
    
    file - path for File
    
    Returns:
    
    text with file content
  - loadFileFromPathAsText
```
public static String loadFileFromPathAsText(File file,
                                            Charset charset)
```
    It read from file and put all content to String with certain encoding.
    
    Parameters:
    
    file - path for File
    
    charset - instance of java.nio.charset.Charset
    
    Returns:
    
    text with file content
  - loadFileFromPathAsText
```
public static String loadFileFromPathAsText(Path path)
```
    It read from file and put all content to String with certain encoding.
    
    Parameters:
    
    path - to file
    
    Returns:
    
    text with file content
  - loadFileFromPathAsText
```
public static String loadFileFromPathAsText(Path path,
                                            Charset charset)
```
    It read from file and put all content to String with certain encoding.
    
    Parameters:
    
    path - to file
    
    charset - instance of java.nio.charset.Charset
    
    Returns:
    
    text with file content
  - loadFileFromClassPathAsText
```
public static String loadFileFromClassPathAsText(String path)
```
    It read from file from classpath and put all content to String.
    
    Parameters:
    
    path - to file
    
    Returns:
    
    text with file content
  - loadFileFromClassPathAsText
```
public static String loadFileFromClassPathAsText(String path,
                                                 Charset charset)
```
    It read from file from classpath and put all content to String with certain encoding.
    
    Parameters:
    
    path - to file
    
    charset - instance of java.nio.charset.Charset
    
    Returns:
    
    text with file content
  - loadFileFromPathToList
```
public static List<String> loadFileFromPathToList(String path)
```
    It reads all lines to list from certain path from system for file. It read whole file content to memory.
    
    Parameters:
    
    path - system path to file to read.
    
    Returns:
    
    list with all lines from file.
  - loadFileFromPathToList
```
public static List<String> loadFileFromPathToList(String path,
                                                  Charset charset)
```
    It reads all lines to list from certain path from system for file. It read whole file content to memory.
    
    Parameters:
    
    path - system path to file to read.
    
    Returns:
    
    list with all lines from file.
  - consumeEveryLineFromFile
```
public static void consumeEveryLineFromFile(String path,
                                            Consumer<String> consumerLine)
```
    It read all lines line by line and put line value to consumerLine argument. It created for performance purpose.
    
    Parameters:
    
    path - system path to file to read.
    
    consumerLine - which consume every line
  - consumeEveryLineFromFile
```
public static void consumeEveryLineFromFile(String path,
                                            Consumer<String> consumerLine,
                                            Charset charset)
```
    It read all lines line by line and put line value to consumerLine argument. It created for performance purpose.
    
    Parameters:
    
    path - system path to file to read.
    
    consumerLine - which consume every line
  - consumeEveryLineWitNumberFromFile
```
public static void consumeEveryLineWitNumberFromFile(String path,
                                                     BiConsumer<Long,String> consumerLineIndex)
```
    It read all lines line by line and put line value to consumerLine argument. It created for performance purpose.
    
    Parameters:
    
    path - system path to file to read.
    
    consumerLineIndex - which consume every line with index of them in file
  - consumeEveryLineWitNumberFromFile
```
public static void consumeEveryLineWitNumberFromFile(String path,
                                                     BiConsumer<Long,String> consumerLineIndex,
                                                     Charset charset)
```
    It read all lines line by line and put line value to consumerLine argument. It created for performance purpose.
    
    Parameters:
    
    path - system path to file to read.
    
    consumerLineIndex - which consume every line with index of them in file
  - readFileFromPathToFileCursor
```
public static FileCursor readFileFromPathToFileCursor(String path)
```
    It create instance of FileCursor.
    
    Parameters:
    
    path - system path to file.
    
    Returns:
    
    instance of FileCursor.
  - readFileFromPathToFileCursor
```
public static FileCursor readFileFromPathToFileCursor(String path,
                                                      Charset charset)
```
    It create instance of FileCursor.
    
    Parameters:
    
    path - system path to file.
    
    Returns:
    
    instance of FileCursor.
  - writeToFile
```
public static void writeToFile(String filePath,
                               String fileContent)
```
    It override current file content if exists. it not create folders with not exist.
    
    Parameters:
    
    filePath - system path to file.
    
    fileContent - as String to write to file
  - writeToFile
```
public static void writeToFile(String filePath,
                               String fileContent,
                               Charset charset)
```
    It override current file content if exists. it not create folders with not exist.
    
    Parameters:
    
    filePath - system path to file.
    
    fileContent - as String to write to file
  - writeToFile
```
public static void writeToFile(File filePath,
                               String fileContent)
```
    It override current file content if exists. it not create folders with not exist.
    
    Parameters:
    
    filePath - system path to file.
    
    fileContent - as String to write to file
  - writeToFile
```
public static void writeToFile(File filePath,
                               String fileContent,
                               Charset charset)
```
    It override current file content if exists. it not create folders with not exist.
    
    Parameters:
    
    filePath - system path to file.
    
    fileContent - as String to write to file
  - writeToFile
```
public static void writeToFile(Path filePath,
                               String fileContent)
```
    It override current file content if exists. it not create folders with not exist.
    
    Parameters:
    
    filePath - system path to file.
    
    fileContent - as String to write to file
  - writeToFile
```
public static void writeToFile(Path filePath,
                               String fileContent,
                               Charset charset)
```
    It override current file content if exists. it not create folders with not exist.
    
    Parameters:
    
    filePath - system path to file.
    
    fileContent - as String to write to file
  - appendToFile
```
public static void appendToFile(String filePath,
                                String fileContent)
```
    Append some text to file.
    
    Parameters:
    
    filePath - system path to file
    
    fileContent - as String to append to file
  - appendToFile
```
public static void appendToFile(String filePath,
                                String fileContent,
                                Charset charset)
```
    Append some text to file.
    
    Parameters:
    
    filePath - system path to file
    
    fileContent - as String to append to file
  - writeAllElementsAsLinesToFile
```
public static void writeAllElementsAsLinesToFile(String filePath,
                                                 List<String> elementToWrite)
```
    It writes all list element to file, every as separated line.
    
    Parameters:
    
    filePath - system path to file
    
    elementToWrite - text lines write to file
  - writeAllElementsAsLinesToFile
```
public static void writeAllElementsAsLinesToFile(String filePath,
                                                 List<String> elementToWrite,
                                                 Charset charset)
```
    It writes all list element to file, every as separated line.
    
    Parameters:
    
    filePath - system path to file
    
    elementToWrite - text lines write to file
  - appendAllElementsAsLinesToFile
```
public static void appendAllElementsAsLinesToFile(String filePath,
                                                  List<String> elementToWrite)
```
    It append all list element to file, every as separated line.
    
    Parameters:
    
    filePath - system path to file
    
    elementToWrite - text lines write to file
  - appendAllElementsAsLinesToFile
```
public static void appendAllElementsAsLinesToFile(String filePath,
                                                  List<String> elementToWrite,
                                                  Charset charset)
```
    It append all list element to file, every as separated line.
    
    Parameters:
    
    filePath - system path to file
    
    elementToWrite - text lines write to file
  - createDirectoriesForFile
```
public static void createDirectoriesForFile(String pathToFile)
```
    It creates directories recursively, leaf of provided path is expected as file name.
    
    Parameters:
    
    pathToFile - as String.
  - createDirectories
```
public static void createDirectories(String folderPath)
```
    It creates directories recursively, all path part will be a folder type.
    
    Parameters:
    
    folderPath - as String.
  - listOfFiles
```
public static List<File> listOfFiles(String pathToFile)
```
    It returns simple list of files.
    
    Parameters:
    
    pathToFile - path to file as simple text
    
    Returns:
    
    list of files
  - listOfFiles
```
public static List<File> listOfFiles(Path path)
```
    It returns simple list of files.
    
    Parameters:
    
    path - by java Path
    
    Returns:
    
    list of files
  - listOfFiles
```
public static List<File> listOfFiles(File rootFile)
```
    It returns simple list of files.
    
    Parameters:
    
    rootFile - as simple java file
    
    Returns:
    
    list of files
  - listOfFiles
```
public static List<File> listOfFiles(String pathToFile,
                                     FileFilter fileFilter)
```
    It returns list of files which were filtered by fileFilter.
    
    Parameters:
    
    pathToFile - path to file as simple text
    
    Returns:
    
    list of files filtered by FileFilter instance
  - listOfFiles
```
public static List<File> listOfFiles(Path path,
                                     FileFilter fileFilter)
```
    It returns list of files which were filtered by fileFilter.
    
    Parameters:
    
    path - by java Path
    
    Returns:
    
    list of files filtered by FileFilter instance
  - listOfFiles
```
public static List<File> listOfFiles(File rootFile,
                                     FileFilter fileFilter)
```
    It returns list of files which were filtered by fileFilter.
    
    Parameters:
    
    rootFile - as simple java file
    
    Returns:
    
    list of files filtered by FileFilter instance
  - deleteFileOrDirectory
```
public static void deleteFileOrDirectory(String pathAsText)
```
    It removes whole directory or file.
    
    Parameters:
    
    pathAsText - path to file as simple text
  - deleteFileOrDirectory
```
public static void deleteFileOrDirectory(File file)
```
    It removes whole directory or file.
    
    Parameters:
    
    file - as simple java file
  - deleteFileOrDirectory
```
public static void deleteFileOrDirectory(Path path)
```
    It removes whole directory or file.
    
    Parameters:
    
    path - by java Path

Class FileUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

loadFileFromPathAsText

loadFileFromPathAsText

loadFileFromPathAsText

loadFileFromPathAsText

loadFileFromPathAsText

loadFileFromPathAsText

loadFileFromClassPathAsText

loadFileFromClassPathAsText

loadFileFromPathToList

loadFileFromPathToList

consumeEveryLineFromFile

consumeEveryLineFromFile

consumeEveryLineWitNumberFromFile

consumeEveryLineWitNumberFromFile

readFileFromPathToFileCursor

readFileFromPathToFileCursor

writeToFile

writeToFile

writeToFile

writeToFile

writeToFile

writeToFile

appendToFile

appendToFile

writeAllElementsAsLinesToFile

writeAllElementsAsLinesToFile

appendAllElementsAsLinesToFile

appendAllElementsAsLinesToFile

createDirectoriesForFile

createDirectories

listOfFiles

listOfFiles

listOfFiles

listOfFiles

listOfFiles

listOfFiles

deleteFileOrDirectory

deleteFileOrDirectory

deleteFileOrDirectory