FilesUtil (converter 1.1.0 API)

java.lang.Object
- com.kamontat.utilities.FilesUtil

```
public class FilesUtil
extends Object
```
Files Utility

Author:

robin, refactor by Sevan Joe, add more by kamontat chantrachirathumrong

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_ENCODING

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_ENCODING`

Constructor Summary

Constructors
Constructor and Description

FilesUtil()

Constructors
Constructor and Description
`FilesUtil()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`copyFile(String srcPath, String dstPath, boolean replace)` copy a file
`static void`	`copyFolder(String srcPath, String dstPath)` copy a folder
`boolean`	`copyTheFile(String fileName, String srcPath, String dstPath)` copy a file from srcPath to dstPath
`static String`	`createFolders(String... paths)` create multi-level directory Example use: createFolders("/", "Users", "Power", "Main");
`static void`	`delAllFile(String folderPath)` delete all files inside folder
`static boolean`	`delFile(String filePathAndName)` delete file
`static void`	`delFolder(String folderPath)` delete folder
`static List<String>`	`getAllFileAbsPath(String path, boolean isDepth)` get all absolute path file in the folder
`static List<String>`	`getAllFileNames(String path, boolean isDepth)` get all abs of file in the folder
`static List<File>`	`getAllFiles(String path, boolean isDepth)` get all files in a folder (Only file)
`static List<File>`	`getAllFiles(String path, String extension)` add all files that matched with extension `getAllFiles(String, String, boolean)`with boolean is `true`
`static List<File>`	`getAllFiles(String path, String extension, boolean isDepth)` get all file from the folder
`static String`	`getExtension(String fileName)` get file extension/suffix (without dot) Example: html, txt, pdf, etc.
`static File`	`getFileFromRoot(String... more)` get path start from `current project path`
`static String`	`getFileName(String path)` get file name from path
`static String`	`getNameWithoutExtension(String fileName)` get file name without extension example: `test.txt` will return `test`
`static FileOutputStream`	`getOutputStream(String path)` get output file, if file not exist automatic create file and if it's still not exist return `null`
`static boolean`	`isDirectory(String path)` check is path a directory
`static boolean`	`isDirectoryEmpty(String path)` check is that directory empty or not
`static boolean`	`isDirectoryExist(String path)` check if directory exists, if not exist, create it, return false if create failed
`static boolean`	`isDirectoryExistNotCreate(String path)` check if directory exists
`static boolean`	`isFileExist(String fileNameAndPath)`
`static boolean`	`isFileExistNotCreate(String fileNameAndPath)` check if the specified file exists
`static boolean`	`moveFile(String srcPath, String dstPath)` move a file
`static void`	`moveFolder(String srcPath, String dstPath)` move a folder
`boolean`	`moveTheFile(String fileName, String srcPath, String dstPath)` move a file
`static boolean`	`newFile(String filePathAndName, String fileContent)` create new file
`static boolean`	`newFile(String filePathAndName, String fileContent, boolean append)` create file
`static boolean`	`newFile(String filePathAndName, String fileContent, String encoding)` create file with specified encoding
`static boolean`	`newFolder(String folderPath)` create folder
`static String`	`readAll(File file)` read all context in file `File`
`static String`	`readAll(String filePathAndName)` read text file content, return string split by "\n"
`static String`	`readAll(String filePathAndName, String encoding)` read text file content, return string split by "\n"
`static String`	`readLine(String filePathAndName, long rowIndex)` read the specified line content of text file
`static List<String>`	`readLine(String filePathAndName, String encoding)` read the line content of text file, in array PS. size of element = number of line
`static String[]`	`separatePath(String path)` separate the path to file name array example: `/var/private/zz/yy` - [var, private, zz, yy]

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

- Field Detail
  - DEFAULT_ENCODING
```
public static String DEFAULT_ENCODING
```
- Constructor Detail
  - FilesUtil
```
public FilesUtil()
```
- Method Detail
  - readAll
```
public static String readAll(File file)
```
    read all context in file File
    
    Parameters:
    
    file - reading file
    
    Returns:
    
    String text content
  - readAll
```
public static String readAll(String filePathAndName)
```
    read text file content, return string split by "\n"
    
    Parameters:
    
    filePathAndName - String file name with absolute path
    
    Returns:
    
    String text content
  - readAll
```
public static String readAll(String filePathAndName,
                             String encoding)
```
    read text file content, return string split by "\n"
    
    Parameters:
    
    filePathAndName - String file name with absolute path
    
    encoding - String file encoding
    
    Returns:
    
    String text content
  - readLine
```
public static List<String> readLine(String filePathAndName,
                                    String encoding)
```
    read the line content of text file, in array
    PS. size of element = number of line
    
    Parameters:
    
    filePathAndName - String file name with absolute path
    
    encoding - String file encoding
    
    Returns:
    
    Array of string content separate by "\n" (new line)
  - readLine
```
public static String readLine(String filePathAndName,
                              long rowIndex)
```
    read the specified line content of text file
    
    Parameters:
    
    filePathAndName - String file name with absolute path
    
    rowIndex - the row number that want to read
    
    Returns:
    
    String text content of the line
  - newFile
```
public static boolean newFile(String filePathAndName,
                              String fileContent)
```
    create new file
    
    Parameters:
    
    filePathAndName - String file path and name
    
    fileContent - String file content
    
    Returns:
    
    boolean flag to indicate create success or not
  - newFile
```
public static boolean newFile(String filePathAndName,
                              String fileContent,
                              boolean append)
```
    create file
    
    Parameters:
    
    filePathAndName - String file path and name
    
    fileContent - String file content
    
    append - true to append, false to create
    
    Returns:
    
    boolean append to indicate create success or not
  - newFile
```
public static boolean newFile(String filePathAndName,
                              String fileContent,
                              String encoding)
```
    create file with specified encoding
    
    Parameters:
    
    filePathAndName - String file path and name
    
    fileContent - String file content
    
    encoding - the specified encoding, such as GBK or UTF-8
    
    Returns:
    
    boolean flag to indicate create success or not
  - delFile
```
public static boolean delFile(String filePathAndName)
```
    delete file
    
    Parameters:
    
    filePathAndName - String file path and name
    
    Returns:
    
    true, if delete successfully
  - delAllFile
```
public static void delAllFile(String folderPath)
```
    delete all files inside folder
    
    Parameters:
    
    folderPath - String folder Path
  - newFolder
```
public static boolean newFolder(String folderPath)
```
    create folder
    
    Parameters:
    
    folderPath - String folder path
    
    Returns:
    
    true, if successful create new folder; otherwise will return false.
  - delFolder
```
public static void delFolder(String folderPath)
```
    delete folder
    
    Parameters:
    
    folderPath - String folder path
  - copyFile
```
public static boolean copyFile(String srcPath,
                               String dstPath,
                               boolean replace)
```
    copy a file
    
    Parameters:
    
    srcPath - String the source path (File)
    
    dstPath - String the destination path (File)
    
    replace - is dstPath exist, and this is true that file will be replaced with new content
    
    Returns:
    
    true, if copy successfully
  - copyFolder
```
public static void copyFolder(String srcPath,
                              String dstPath)
```
    copy a folder
    
    Parameters:
    
    srcPath - String the source path
    
    dstPath - String the destination path
  - moveFile
```
public static boolean moveFile(String srcPath,
                               String dstPath)
```
    move a file
    
    Parameters:
    
    srcPath - String the source path
    
    dstPath - String the destination path
    
    Returns:
    
    true, if move sucessfully
  - moveFolder
```
public static void moveFolder(String srcPath,
                              String dstPath)
```
    move a folder
    
    Parameters:
    
    srcPath - String the source path
    
    dstPath - String the destination path
  - createFolders
```
public static String createFolders(String... paths)
```
    create multi-level directory
    Example use: createFolders("/", "Users", "Power", "Main");
    
    Parameters:
    
    paths - must be at least 1 element is root folder (Optional) the folder that want to created.
    
    Returns:
    
    String the created directory path or empty string if something error
  - getFileFromRoot
```
public static File getFileFromRoot(String... more)
```
    get path start from current project path
    
    Parameters:
    
    more - addition string to be joined to start path
    
    Returns:
    
    File
    
    See Also:
    
    Paths.get(String, String...)
  - getAllFiles
```
public static List<File> getAllFiles(String path,
                                     boolean isDepth)
```
    get all files in a folder (Only file)
    
    Parameters:
    
    path - String folder path
    
    isDepth - true is need to scan all subdirectories
    
    Returns:
    
    List of File that content all file in the folder
  - getAllFiles
```
public static List<File> getAllFiles(String path,
                                     String extension)
```
    add all files that matched with extension
    getAllFiles(String, String, boolean)with boolean is true
    
    Parameters:
    
    path - folder path
    
    extension - file extension
    
    Returns:
    
    all file matching extension
  - getAllFiles
```
public static List<File> getAllFiles(String path,
                                     String extension,
                                     boolean isDepth)
```
    get all file from the folder
    
    Parameters:
    
    path - folder path
    
    extension - filter file extension
    
    isDepth - recursive reading sub folder
    
    Returns:
    
    all file matching extension
  - getAllFileAbsPath
```
public static List<String> getAllFileAbsPath(String path,
                                             boolean isDepth)
```
    get all absolute path file in the folder
    
    Parameters:
    
    path - String folder path
    
    isDepth - boolean is need to scan all subdirectories
    
    Returns:
    
    List of the String
  - getAllFileNames
```
public static List<String> getAllFileNames(String path,
                                           boolean isDepth)
```
    get all abs of file in the folder
    
    Parameters:
    
    path - String folder path
    
    isDepth - boolean is need to scan all subdirectories
    
    Returns:
    
    List of the String
  - getExtension
```
public static String getExtension(String fileName)
```
    get file extension/suffix (without dot)
    Example: html, txt, pdf, etc.
    
    Parameters:
    
    fileName - file name
    
    Returns:
    
    extension/suffix of file
  - getNameWithoutExtension
```
public static String getNameWithoutExtension(String fileName)
```
    get file name without extension
    example: test.txt will return test
    
    Parameters:
    
    fileName - file name or file name with path
    
    Returns:
    
    file name without extension
  - getFileName
```
public static String getFileName(String path)
```
    get file name from path
    
    Parameters:
    
    path - absolute file/folder path
    
    Returns:
    
    name of the file
  - isFileExist
```
public static boolean isFileExist(String fileNameAndPath)
```
  - isFileExistNotCreate
```
public static boolean isFileExistNotCreate(String fileNameAndPath)
```
    check if the specified file exists
    
    Parameters:
    
    fileNameAndPath - the name of the file to be checked
    
    Returns:
    
    boolean true if exits, false if not
  - isDirectoryExist
```
public static boolean isDirectoryExist(String path)
```
    check if directory exists, if not exist, create it, return false if create failed
    
    Parameters:
    
    path - folder path
    
    Returns:
    
    boolean
  - isDirectoryExistNotCreate
```
public static boolean isDirectoryExistNotCreate(String path)
```
    check if directory exists
    
    Parameters:
    
    path - folder path
    
    Returns:
    
    boolean
  - isDirectory
```
public static boolean isDirectory(String path)
```
    check is path a directory
    
    Parameters:
    
    path - absolute folder path
    
    Returns:
    
    true if path is directory path
  - isDirectoryEmpty
```
public static boolean isDirectoryEmpty(String path)
```
    check is that directory empty or not
    
    Parameters:
    
    path - absolute folder path
    
    Returns:
    
    true if the path is empty directory
  - copyTheFile
```
public boolean copyTheFile(String fileName,
                           String srcPath,
                           String dstPath)
```
    copy a file from srcPath to dstPath
    
    Parameters:
    
    fileName - file name (File)
    
    srcPath - source path (Folder)
    
    dstPath - destination path (Folder)
    
    Returns:
    
    true, if copy successfully; otherwise return false
  - moveTheFile
```
public boolean moveTheFile(String fileName,
                           String srcPath,
                           String dstPath)
```
    move a file
    
    Parameters:
    
    fileName - file name (File)
    
    srcPath - source path (Folder)
    
    dstPath - destination path (Folder)
    
    Returns:
    
    true, if copy successfully; otherwise return false
  - separatePath
```
public static String[] separatePath(String path)
```
    separate the path to file name array
    example: /var/private/zz/yy - [var, private, zz, yy]
    
    Parameters:
    
    path - file name with absolute path
    
    Returns:
    
    file or folder string in each element
  - getOutputStream
```
public static FileOutputStream getOutputStream(String path)
```
    get output file, if file not exist automatic create file and if it's still not exist return null
    
    Parameters:
    
    path - file name with absolute path
    
    Returns:
    
    output stream

Class FilesUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ENCODING

Constructor Detail

FilesUtil

Method Detail

readAll

readAll

readAll

readLine

readLine

newFile

newFile

newFile

delFile

delAllFile

newFolder

delFolder

copyFile

copyFolder

moveFile

moveFolder

createFolders

getFileFromRoot

getAllFiles

getAllFiles

getAllFiles

getAllFileAbsPath

getAllFileNames

getExtension

getNameWithoutExtension

getFileName

isFileExist

isFileExistNotCreate

isDirectoryExist

isDirectoryExistNotCreate

isDirectory

isDirectoryEmpty

copyTheFile

moveTheFile

separatePath

getOutputStream