org.codice.ddf.configuration.migration

Class PathUtils

java.lang.Object

org.codice.ddf.configuration.migration.PathUtils

public class PathUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
PathUtils() Creates a new path utility.

Method Summary

Modifier and Type	Method and Description
static boolean	cleanQuietly(Path path, MigrationReport report) Quietly deletes the specified file or recursively cleans up the specified directory by removing all empty sub-directories.
static boolean	deleteQuietly(Path path, String type) Quietly deletes the specified file or recursively deletes the specified directory and audit the result.
String	getChecksumFor(Path path) Calculate the checksum for the specified path.
Path	getDDFHome() Gets the path to ${ddf.home}.
boolean	isRelativeToDDFHome(Path path) Checks if the specified path is located under ${ddf.home}.
Path	relativizeFromDDFHome(Path path) Relativizes the specified path from ${ddf.home}.
Path	resolveAgainstDDFHome(Path path) Resolves the specified path against ${ddf.home}.
Path	resolveAgainstDDFHome(String path) Resolves the specified path against ${ddf.home}.

Methods inherited from class java.lang.Object

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

Constructor Detail

PathUtils

public PathUtils()

Creates a new path utility.

Throws:

IOError - if unable to determine ${ddf.home}

Method Detail

deleteQuietly

public static boolean deleteQuietly(Path path,
                                    String type)

Quietly deletes the specified file or recursively deletes the specified directory and audit the result. The provided directory is deleted.

Parameters:

path - the file or directory to be deleted

type - a string representing the type of file or directory to delete

Returns:

true if the file or directory was deleted, false otherwise

Throws:

IllegalArgumentException - if path or type is null

cleanQuietly

public static boolean cleanQuietly(Path path,
                                   MigrationReport report)

Quietly deletes the specified file or recursively cleans up the specified directory by removing all empty sub-directories. The provided directory is not deleted even if it becomes empty.

Parameters:

path - the file ot directory to be cleaned

report - the report where to record warning messages if unable to delete the file or directories

Returns:

true if the file was deleted or the directory is empty, false otherwise

Throws:

IllegalArgumentException - if path or report is null

getDDFHome

public Path getDDFHome()

Gets the path to ${ddf.home}.

Returns:

the path to ${ddf.home}

isRelativeToDDFHome

public boolean isRelativeToDDFHome(Path path)

Checks if the specified path is located under ${ddf.home}.

Parameters:

path - the path to check if it is relative from ${ddf.home}

Returns:

true if the path it located under ${ddf.home}; false otherwise

relativizeFromDDFHome

public Path relativizeFromDDFHome(Path path)

Relativizes the specified path from ${ddf.home}.

Parameters:

path - the path to relativize from ${ddf.home}

Returns:

the corresponding relativize path or path if it is not located under ${ddf.home}

resolveAgainstDDFHome

public Path resolveAgainstDDFHome(Path path)

Resolves the specified path against ${ddf.home}.

Parameters:

path - the path to resolve against ${ddf.home}

Returns:

the corresponding path resolved against ${ddf.home} if it is relative; otherwise path

resolveAgainstDDFHome

public Path resolveAgainstDDFHome(String path)

Resolves the specified path against ${ddf.home}.

Parameters:

path - the path to resolve against ${ddf.home}

Returns:

the corresponding path resolved against ${ddf.home} if it is relative; otherwise a path corresponding to pathname

getChecksumFor

public String getChecksumFor(Path path)
                      throws IOException

Calculate the checksum for the specified path.

Parameters:

path - the path to calculate the checksum for

Returns:

the corresponding checksum

Throws:

IllegalArgumentException - if path is null

IOException - if an I/O error occurred