Package com.github.toolarium.common.util

Class FileUtil

java.lang.Object

com.github.toolarium.common.util.FileUtil

public final class FileUtil
extends Object

Defines a file utility.

Field Summary

Fields

Modifier and Type	Field	Description
static final char	BACKSLASH
static final String	BACKSLASH_STR
static final char	SLASH
static final String	SLASH_STR

Method Summary

Modifier and Type	Method	Description
boolean	existFile(String fileName)	Check if a given file exist
String	extractURLPath(URL url)	Extract the path from an url
static FileUtil	getInstance()	Get the instance
boolean	isReadable(String fileName)	Checks whether the given file or directory is readable.
boolean	isWritable(String fileName)	Checks whether the given file or directory is writable.
String	readFileContent(File file)	Read the file content
String	readFileContent(File file, Charset charset)	Read the file content
String	readFileContent(URL url)	Read file content from a url
String	readFileContent(Path file)	Read the file content
String	readFileContent(Path file, Charset charset)	Read the file content
boolean	removeDirectory(File dir)	Deletes all files and sub directories under dir.
boolean	removeDirectory(Path dir)	Deletes all files and sub directories under dir.
boolean	removeFile(File file)	Removes a file
boolean	removeFile(String fileName)	Removes a file
String	simplifyPath(String path)	Simplify a given path
String	slashify(String path)	Slashify the path
void	writeFileContent(File file, String content)	Write the file content
void	writeFileContent(File file, Charset charset, String content)	Write the file content
void	writeFileContent(Path file, String content)	Write the file content
void	writeFileContent(Path file, Charset charset, String content)	Write the file content

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SLASH

public static final char SLASH

See Also:

• Constant Field Values

BACKSLASH

public static final char BACKSLASH

See Also:

• Constant Field Values

SLASH_STR

public static final String SLASH_STR

See Also:

• Constant Field Values

BACKSLASH_STR

public static final String BACKSLASH_STR

See Also:

• Constant Field Values

Method Details

getInstance

public static FileUtil getInstance()

Get the instance

Returns:

the instance

simplifyPath

public String simplifyPath(String path)

Simplify a given path

Parameters:

path - the path to simplify

Returns:

the path

slashify

public String slashify(String path)

Slashify the path

Parameters:

path - the path

Returns:

the prepared path

existFile

public boolean existFile(String fileName)

Check if a given file exist

Parameters:

fileName - the filename

Returns:

true if the file exist otherwise false

isReadable

public boolean isReadable(String fileName)

Checks whether the given file or directory is readable.

Parameters:

fileName - the filename to be checked

Returns:

true if the file can be read otherwise false

isWritable

public boolean isWritable(String fileName)

Checks whether the given file or directory is writable.

Parameters:

fileName - the filename to be checked

Returns:

true if the file can be written otherwise false

removeFile

public boolean removeFile(String fileName)

Removes a file

Parameters:

fileName - the file to remove

Returns:

returns true if all deletions were successful.

removeFile

public boolean removeFile(File file)

Removes a file

Parameters:

file - the file to remove

Returns:

removes a file

removeDirectory

public boolean removeDirectory(Path dir)

Deletes all files and sub directories under dir. If a deletion fails, the method stops attempting to delete and returns false.

Parameters:

dir - the directory to delete

Returns:

returns true if all deletions were successful.

removeDirectory

public boolean removeDirectory(File dir)

Deletes all files and sub directories under dir. If a deletion fails, the method stops attempting to delete and returns false.

Parameters:

dir - the directory to delete

Returns:

returns true if all deletions were successful.

extractURLPath

public String extractURLPath(URL url)

Extract the path from an url

Parameters:

url - the url

Returns:

the path

readFileContent

public String readFileContent(File file)
                       throws IOException

Read the file content

Parameters:

file - the file

Returns:

the content

Throws:

IOException - In case of an IO error

readFileContent

public String readFileContent(Path file)
                       throws IOException

Read the file content

Parameters:

file - the file

Returns:

the content

Throws:

IOException - In case of an IO error

readFileContent

public String readFileContent(File file,
 Charset charset)
                       throws IOException

Read the file content

Parameters:

file - the file

charset - the charset

Returns:

the content

Throws:

IOException - In case of an IO error

readFileContent

public String readFileContent(Path file,
 Charset charset)
                       throws IOException

Read the file content

Parameters:

file - the file

charset - the charset

Returns:

the content

Throws:

IOException - In case of an IO error

readFileContent

public String readFileContent(URL url)
                       throws IOException

Read file content from a url

Parameters:

url - the url

Returns:

the content

Throws:

IOException - In case of an IO error

writeFileContent

public void writeFileContent(Path file,
 String content)
                      throws IOException

Write the file content

Parameters:

file - the file

content - the content

Throws:

IOException - In case of an IO error

writeFileContent

public void writeFileContent(File file,
 String content)
                      throws IOException

Write the file content

Parameters:

file - the file

content - the content

Throws:

IOException - In case of an IO error

writeFileContent

public void writeFileContent(File file,
 Charset charset,
 String content)
                      throws IOException

Write the file content

Parameters:

file - the file

charset - the charset

content - the content

Throws:

IOException - In case of an IO error

writeFileContent

public void writeFileContent(Path file,
 Charset charset,
 String content)
                      throws IOException

Write the file content

Parameters:

file - the file

charset - the charset

content - the content

Throws:

IOException - In case of an IO error