gov.nih.nci.ncicb.tcga.dcc.io.api.util.nio

Class FileUtil

java.lang.Object

gov.nih.nci.ncicb.tcga.dcc.io.api.util.nio.FileUtil

public abstract class FileUtil
extends Object

NIO File utilities.

Author:

nichollsmc

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	FILE_EXTENSION_PATTERN Constant that defines the Pattern used for matching file extensions.
static String	WILDCARD_GLOB_PATTERN Constant that defines the wildcard (*) glob pattern used for filtering Path elements.

Constructor Summary

Constructors

Constructor and Description
FileUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static List<Path>	listFiles(Path path, String globPattern) Returns a list of Path elements representing entries within the specified directory path, filtered by the specified globbing pattern.
static List<Path>	listFiles(String path) Returns a list of Paths for the specified string representing a directory path.
static List<Path>	listFiles(URI path) Returns a list of Paths for the specified URI representing a directory path.

Methods inherited from class java.lang.Object

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

Field Detail

WILDCARD_GLOB_PATTERN

public static final String WILDCARD_GLOB_PATTERN

Constant that defines the wildcard (*) glob pattern used for filtering Path elements.

See Also:

Constant Field Values

FILE_EXTENSION_PATTERN

public static final Pattern FILE_EXTENSION_PATTERN

Constant that defines the Pattern used for matching file extensions.

     \\.[^.\\/:*?\"<>|\r\n]+$
 

Constructor Detail

FileUtil

public FileUtil()

Method Detail

listFiles

public static List<Path> listFiles(String path)
                            throws IOException

Returns a list of Paths for the specified string representing a directory path.

This method uses the default glob pattern specified by WILDCARD_GLOB_PATTERN.

Parameters:

path - the path to the directory

Returns:

the list of Paths for the specified directory path

Throws:

IOException - if an I/O error occurs

listFiles

public static List<Path> listFiles(URI path)
                            throws IOException

Returns a list of Paths for the specified URI representing a directory path.

This method uses the default glob pattern specified by WILDCARD_GLOB_PATTERN.

Parameters:

path - the path to the directory

Returns:

the list of Paths for the specified directory path

Throws:

IOException - if an I/O error occurs

listFiles

public static List<Path> listFiles(Path path,
                   String globPattern)
                            throws IOException

Returns a list of Path elements representing entries within the specified directory path, filtered by the specified globbing pattern.

If the globPattern is null, the default glob pattern WILDCARD_GLOB_PATTERN will be used.

If the globPattern matches a file extension (e.g. .txt), the WILDCARD_GLOB_PATTERN will be prepended to the globPattern (e.g. *.txt).

Parameters:

path - the path to the directory

globPattern - the glob pattern

Returns:

the list of Paths for the specified directory path and glob pattern

Throws:

IOException - IOException if an I/O error occurs

See Also:

Files#newDirectoryStream(Path, String)}