org.savantbuild.io

Class FileSet

java.lang.Object

org.savantbuild.io.FileSet

Direct Known Subclasses:

ArchiveFileSet

public class FileSet
extends java.lang.Object

A FileSet represents a set of files within a directory. Currently, this only models all of the files contained in a directory and all sub-directories below it.

Field Summary

Fields

Modifier and Type	Field and Description
java.nio.file.Path	directory
java.util.Set<java.util.regex.Pattern>	excludePatterns
java.util.Set<java.util.regex.Pattern>	includePatterns
static java.util.Set<java.lang.String>	REQUIRED_ATTRIBUTES
static java.util.Set<java.lang.String>	VALID_ATTRIBUTES

Constructor Summary

Constructors

Constructor and Description
FileSet(java.nio.file.Path directory) Constructs a new FileSet.
FileSet(java.nio.file.Path directory, java.util.Collection<java.util.regex.Pattern> includePatterns, java.util.Collection<java.util.regex.Pattern> excludePatterns) Constructs a new FileSet.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	attributesValid(java.util.Map<java.lang.String,java.lang.Object> attributes) Determines if the attributes given can be used to construct a FileSet.
static FileSet	fromAttributes(java.nio.file.Path dir, java.util.Map<java.lang.String,java.lang.Object> attributes) Constructs a FileSet from a Map of attributes.
java.util.Set<Directory>	toDirectories() Builds the set of directories that all of the files in this FileSet are contained within.
java.util.List<FileInfo>	toFileInfos() Converts this FileSet to a list of FileInfo objects.
FileSet	withExcludePatterns(java.util.List<java.util.regex.Pattern> excludePatterns) Sets the excludePatterns.
FileSet	withIncludePatterns(java.util.List<java.util.regex.Pattern> includePatterns) Sets the includePatterns.

Methods inherited from class java.lang.Object

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

Field Detail

REQUIRED_ATTRIBUTES

public static final java.util.Set<java.lang.String> REQUIRED_ATTRIBUTES

VALID_ATTRIBUTES

public static final java.util.Set<java.lang.String> VALID_ATTRIBUTES

directory

public final java.nio.file.Path directory

excludePatterns

public final java.util.Set<java.util.regex.Pattern> excludePatterns

includePatterns

public final java.util.Set<java.util.regex.Pattern> includePatterns

Constructor Detail

FileSet

public FileSet(java.nio.file.Path directory)

Constructs a new FileSet.

Parameters:

directory - The directory of the FileSet.

FileSet

public FileSet(java.nio.file.Path directory,
               java.util.Collection<java.util.regex.Pattern> includePatterns,
               java.util.Collection<java.util.regex.Pattern> excludePatterns)

Constructs a new FileSet. The directory is required but everything else is optional.

Parameters:

directory - The directory of the FileSet.

includePatterns - (Optional) A list of regular expression Pattern objects that list the files to include.

excludePatterns - (Optional) A list of regular expression Pattern objects that list the files to exclude.

Method Detail

attributesValid

public static java.lang.String attributesValid(java.util.Map<java.lang.String,java.lang.Object> attributes)

Determines if the attributes given can be used to construct a FileSet.

Parameters:

attributes - The attributes.

Returns:

Null if the attributes are valid, an error message describing why they aren't valid.

fromAttributes

public static FileSet fromAttributes(java.nio.file.Path dir,
                                     java.util.Map<java.lang.String,java.lang.Object> attributes)

Constructs a FileSet from a Map of attributes.

Parameters:

dir - The directory for the FileSet.

attributes - The attributes.

Returns:

The FileSet.

toDirectories

public java.util.Set<Directory> toDirectories()
                                       throws java.io.IOException

Builds the set of directories that all of the files in this FileSet are contained within.

Returns:

The directories.

Throws:

java.io.IOException - If the build fails.

toFileInfos

public java.util.List<FileInfo> toFileInfos()
                                     throws java.io.IOException

Converts this FileSet to a list of FileInfo objects. The info objects contain the origin Path and a relative Path. They also include additional information about the file.

Returns:

A List of FileInfo objects for this FileSet.

Throws:

java.io.IOException - If the directory traversal fails.

withExcludePatterns

public FileSet withExcludePatterns(java.util.List<java.util.regex.Pattern> excludePatterns)

Sets the excludePatterns.

Parameters:

excludePatterns - The excludePatterns.

Returns:

This.

withIncludePatterns

public FileSet withIncludePatterns(java.util.List<java.util.regex.Pattern> includePatterns)

Sets the includePatterns.

Parameters:

includePatterns - The includePatterns.

Returns:

This.