com.goldencode.p2j.util

Class FileListFactory

java.lang.Object

com.goldencode.p2j.util.FileListFactory

public class FileListFactory
extends java.lang.Object

Static helpers to create file lists.

Field Summary

Fields

Modifier and Type	Field and Description
private static ConversionStatus	LOG Logger

Constructor Summary

Constructors

Constructor and Description
FileListFactory()

Method Summary

Modifier and Type	Method and Description
private static java.lang.String	cleanup(java.lang.String input) Replace any file system separators with the OS-specific version and honor the comment character.
private static java.lang.String	commentLine(java.lang.String input) Check if the line is a comment line.
static FileList	createBlacklist(java.lang.String rootPath, java.lang.String spec, boolean recurse, boolean cs, java.lang.String blacklist) Create an instance using the given inputs.
static FileList	createExplicit(java.lang.String filename) Create an instance using the given inputs.
static FileSet	loadFileSet(java.lang.String filename) Load a file set, from a disk file.
private static void	malformedFileSetLine(java.lang.String line, int idx, java.lang.String filename) Raise an IllegalStateException to report an error when reading a file-set configuration file.
static FileList	processFileSet(FileSet fileSet, boolean caseSens) Resolve the file set, by using the initial files (loaded from the reference directory or explicit file names), and applying the Include and eXclude operations.
static java.lang.String[]	resolvePaths(java.lang.String[] paths) Given a list of directory paths, resolve them in terms that they will match the exact path as reported on the operating system were the conversion is ran.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final ConversionStatus LOG

Logger

Constructor Detail

FileListFactory

public FileListFactory()

Method Detail

processFileSet

public static FileList processFileSet(FileSet fileSet,
                                      boolean caseSens)
                               throws java.io.IOException

Resolve the file set, by using the initial files (loaded from the reference directory or explicit file names), and applying the Include and eXclude operations.

Parameters:

fileSet - The file set.

caseSens - Flag indicating if the legacy operating system is case-sensitive or not.

Returns:

The resolved file list.

Throws:

java.io.IOException - In case of problems reading files from disk.

loadFileSet

public static FileSet loadFileSet(java.lang.String filename)

Load a file set, from a disk file. Each line on this file follows this syntax:

• D <recursive_top_level_dir> <file_spec> adds a top level dir and file spec which will be recursively processed to add 0 or more files into the reference file list.
• N <non_recursive_top_level_dir> <file_spec> adds a top level dir and file spec which will be non-recursively processed to add 0 or more files into the list
• F <absolute_or_relative_file_name> - explicitly adds a single/individual file into the list
• X <exclusion_filter_expression_including_wildcards> - filter to remove from the list
• I <inclusion_filter_expression_including_wildcards> - filter to add something removed back into the list
• # this is a comment, a line starting with a # character, representing a comment, which will be ignored

Parameters:

filename - The file name from which to load the file set.

Returns:

The loaded file set, or null in case it could not be loaded.

createExplicit

public static FileList createExplicit(java.lang.String filename)

Create an instance using the given inputs.

Parameters:

filename - Text file name containing the list of files from which to create the list.

Returns:

The file list or null if there is a failure.

createBlacklist

public static FileList createBlacklist(java.lang.String rootPath,
                                       java.lang.String spec,
                                       boolean recurse,
                                       boolean cs,
                                       java.lang.String blacklist)

Create an instance using the given inputs.

Parameters:

rootPath - Path to the top level root directory in which files will be listed.

spec - Regex controlling which files in the root path will be processed.

recurse - true to process subdirectories recursively.

cs - true to process with case-sensitivity.

blacklist - The filename of the ignore list.

Returns:

The file list or null if there is a failure.

resolvePaths

public static java.lang.String[] resolvePaths(java.lang.String[] paths)
                                       throws java.io.IOException

Given a list of directory paths, resolve them in terms that they will match the exact path as reported on the operating system were the conversion is ran.

Parameters:

paths - The paths to resolve.

Returns:

The resolved paths.

Throws:

java.io.IOException - In case a path can't be resolved.

malformedFileSetLine

private static void malformedFileSetLine(java.lang.String line,
                                         int idx,
                                         java.lang.String filename)

Raise an IllegalStateException to report an error when reading a file-set configuration file.

Parameters:

line - The original line.

idx - The line index in the file.

filename - The name of the file.

commentLine

private static java.lang.String commentLine(java.lang.String input)

Check if the line is a comment line.

Parameters:

input - The line to check.

Returns:

null if the line starts with '#' character.

cleanup

private static java.lang.String cleanup(java.lang.String input)

Replace any file system separators with the OS-specific version and honor the comment character. If the first character on the line is a hash (#) character, then the entire line is ignored (dropped from the output). A hash character anywhere else in a given line is treated as valid text.

Parameters:

input - Name of the file to be read. Must be relative to the current directory or fully qualified.

Returns:

The cleaned text or null if this is a comment.