de.hawhamburg.reachability.util

Class ExternFileUtil

java.lang.Object

de.hawhamburg.reachability.util.ExternFileUtil

public final class ExternFileUtil
extends java.lang.Object

Utility functions related to external file handling.

This utility class provides some fancy methods related to external file modifications.

Version:

"2013.42"

Author:

"Malte Kantak <malte.kantak@hotmail.de>"

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ExternFileUtil() Prevent instances of this utility class.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	createAndWrite(java.lang.String path, java.lang.String content) Creates a new file which is referred to be the given path and writes the supplied content into it, by using createEmpty(String).
static boolean	createEmpty(java.lang.String path) Creates a new empty file with the supplied path name, if the path doesn't refer to an existing file.
static boolean	exists(java.lang.String path) Checks whether the supplied file path exists or not.
static java.util.List<java.lang.String>	getContentLines(java.lang.String path) Returns the content of the supplied file as list of lines.
static boolean	isAccessible(java.lang.String path) Check whether the file is accessible for read operations or not.
static boolean	isFile(java.lang.String path) Checks whether the supplied path refers to a file or not.
static boolean	isFile(java.lang.String path, java.lang.String suffix) Checks whether the supplied path refers to a file of a certain type or not.
static boolean	remove(java.lang.String path) Removes the file referred to by the supplied file path if it's existing.
static boolean	write(java.lang.String path, java.lang.String content) Writes the given content to the file referred to by the supplied path name.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternFileUtil

private ExternFileUtil()

Prevent instances of this utility class.

Method Detail

exists

public static boolean exists(java.lang.String path)

Checks whether the supplied file path exists or not.

Parameters:

path - The path referred to the file which existence shall be checked.

Returns:

true if the supplied path refers to an existing file, otherwise false.

isAccessible

public static boolean isAccessible(java.lang.String path)

Check whether the file is accessible for read operations or not. This includes an existence and an is file check.

Parameters:

path - The path referred to the file of which the accessibility shall be checked.

Returns:

true if the supplied path refers to an accessible file, otherwise false.

isFile

public static boolean isFile(java.lang.String path)

Checks whether the supplied path refers to a file or not.

Parameters:

path - The path which shall be checked.

Returns:

true if the supplied path refers to a file, otherwise false.

isFile

public static boolean isFile(java.lang.String path,
             java.lang.String suffix)

Checks whether the supplied path refers to a file of a certain type or not.

Parameters:

path - The path which shall be checked.

suffix - The suffix of this file.

Returns:

true if the supplied path refers to a file, otherwise false.

getContentLines

public static java.util.List<java.lang.String> getContentLines(java.lang.String path)

Returns the content of the supplied file as list of lines. If the file doesn't exist, null will be returned instead.

Parameters:

path - The file which content shall be returned as list of lines.

Returns:

A List of lines as String representing the supplied files content.

remove

public static boolean remove(java.lang.String path)

Removes the file referred to by the supplied file path if it's existing.

Parameters:

path - The path pointing to the file which shall be removed.

Returns:

true on success, otherwise false.

createEmpty

public static boolean createEmpty(java.lang.String path)

Creates a new empty file with the supplied path name, if the path doesn't refer to an existing file.

Parameters:

path - The path to the new file.

Returns:

true on success, otherwise false.

write

public static boolean write(java.lang.String path,
            java.lang.String content)

Writes the given content to the file referred to by the supplied path name.

Parameters:

path - The path to the file to which the supplied content shall be written.

content - The content which shall be written to the given file.

Returns:

true on success, otherwise false.

createAndWrite

public static boolean createAndWrite(java.lang.String path,
                     java.lang.String content)

Creates a new file which is referred to be the given path and writes the supplied content into it, by using createEmpty(String).

Parameters:

path - The path the new file which shall be created.

content - The content which shall be written to the new file.

Returns:

true, on success, otherwise false.