FileUtils (java-utils 1.1.0 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`	`appendToFile(String filePath, String fileContent)` 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`	`consumeEveryLineWitNumberFromFile(String path, BiConsumer<Long,String> consumerLineIndex)` 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 List<File>`	`listOfFiles(String pathToFile)`
`static List<File>`	`listOfFiles(String pathToFile, FileFilter 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(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 FileCursor`	`readFileFromPathToFileCursor(String path)` 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`	`writeToFile(String filePath, String fileContent)` 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
  - 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.
  - 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
  - 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
  - readFileFromPathToFileCursor
```
public static FileCursor readFileFromPathToFileCursor(String path)
```
    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
  - 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
  - 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
  - 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
  - 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)
```
  - listOfFiles
```
public static List<File> listOfFiles(String pathToFile,
                                     FileFilter fileFilter)
```

Class FileUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

loadFileFromPathAsText

loadFileFromPathAsText

loadFileFromClassPathAsText

loadFileFromClassPathAsText

loadFileFromPathToList

consumeEveryLineFromFile

consumeEveryLineWitNumberFromFile

readFileFromPathToFileCursor

writeToFile

appendToFile

writeAllElementsAsLinesToFile

appendAllElementsAsLinesToFile

createDirectoriesForFile

createDirectories

listOfFiles

listOfFiles