org.savantbuild.io

Class ArchiveFileSet

java.lang.Object

org.savantbuild.io.FileSet

org.savantbuild.io.ArchiveFileSet

public class ArchiveFileSet
extends FileSet

A FileSet for archives. This allows the files in the FileSet to optionally contain a prefix.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	dirGroupName
java.lang.Integer	dirMode
java.lang.String	dirUserName
java.lang.String	groupName
java.lang.Integer	mode
java.lang.String	prefix
static java.util.Set<java.lang.String>	REQUIRED_ATTRIBUTES
java.lang.String	userName
static java.util.Set<java.lang.String>	VALID_ATTRIBUTES

Fields inherited from class org.savantbuild.io.FileSet

directory, excludePatterns, includePatterns

Constructor Summary

Constructors

Constructor and Description
ArchiveFileSet(java.nio.file.Path directory) Constructs a new ArchiveFileSet.
ArchiveFileSet(java.nio.file.Path directory, java.lang.String prefix) Constructs a new ArchiveFileSet.
ArchiveFileSet(java.nio.file.Path directory, java.lang.String prefix, java.lang.Integer mode, java.lang.String userName, java.lang.String groupName, java.lang.String dirUserName, java.lang.String dirGroupName, java.lang.Integer dirMode, java.util.Collection<java.util.regex.Pattern> includePatterns, java.util.Collection<java.util.regex.Pattern> excludePatterns) Constructs a new ArchiveFileSet.

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 an ArchiveFileSet.
static ArchiveFileSet	fromAttributes(java.nio.file.Path dir, java.util.Map<java.lang.String,java.lang.Object> attributes) Constructs an ArchiveFileSet from a Map of attributes.
java.util.Set<Directory>	toDirectories() Overrides the parent method, but uses the dirGroupName, dirUserName and dirMode variables to set the mode, userName and groupName inside the returned Directory objects.
java.util.List<FileInfo>	toFileInfos() Converts this FileSet to a list of FileInfo objects.
ArchiveFileSet	withDirGroupName(java.lang.String dirGroupName) Sets the dirGroupName.
ArchiveFileSet	withDirMode(java.lang.Integer dirMode) Sets the dirMode.
ArchiveFileSet	withDirUserName(java.lang.String dirUserName) Sets the dirUserName.
ArchiveFileSet	withGroupName(java.lang.String groupName) Sets the groupName.
ArchiveFileSet	withMode(java.lang.Integer mode) Sets the mode.
ArchiveFileSet	withPrefix(java.lang.String prefix) Sets the prefix.
ArchiveFileSet	withUserName(java.lang.String userName) Sets the userName.

Methods inherited from class org.savantbuild.io.FileSet

withExcludePatterns, withIncludePatterns

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

dirGroupName

public java.lang.String dirGroupName

dirMode

public java.lang.Integer dirMode

dirUserName

public java.lang.String dirUserName

groupName

public java.lang.String groupName

mode

public java.lang.Integer mode

prefix

public java.lang.String prefix

userName

public java.lang.String userName

Constructor Detail

ArchiveFileSet

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

Constructs a new ArchiveFileSet.

Parameters:

directory - The directory of the FileSet.

ArchiveFileSet

public ArchiveFileSet(java.nio.file.Path directory,
                      java.lang.String prefix)

Constructs a new ArchiveFileSet. The directory is required but the prefix is optional. Leaving the prefix blank will cause all of the files in the FileSet to contain relative paths based on the FileSet's directory. Using the prefix will cause the files in the FileSet to be relative to the prefix plus the directory.

Parameters:

directory - The directory of the FileSet.

prefix - The prefix used to calculate the relative paths in the FileInfo objects.

ArchiveFileSet

public ArchiveFileSet(java.nio.file.Path directory,
                      java.lang.String prefix,
                      java.lang.Integer mode,
                      java.lang.String userName,
                      java.lang.String groupName,
                      java.lang.String dirUserName,
                      java.lang.String dirGroupName,
                      java.lang.Integer dirMode,
                      java.util.Collection<java.util.regex.Pattern> includePatterns,
                      java.util.Collection<java.util.regex.Pattern> excludePatterns)

Constructs a new ArchiveFileSet. The directory is required but the prefix is optional. Leaving the prefix blank will cause all of the files in the FileSet to contain relative paths based on the FileSet's directory. Using the prefix will cause the files in the FileSet to be relative to the prefix plus the directory.

Parameters:

directory - The directory of the FileSet.

prefix - (Optional) The prefix used to calculate the relative paths in the FileInfo objects.

mode - (Optional) The POSIX file mode.

userName - (Optional) The user name for the fileset.

groupName - (Optional) The group name for the fileset.

dirUserName - (Optional) The user name that the directories created by this ArchiveFileSet will use.

dirGroupName - (Optional) The group name that the directories created by this ArchiveFileSet will use.

dirMode - (Optional) The mode that the directories created by this ArchiveFileSet will use.

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 an ArchiveFileSet.

Parameters:

attributes - The attributes.

Returns:

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

fromAttributes

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

Constructs an ArchiveFileSet from a Map of attributes.

Parameters:

dir - The directory for the ArchiveFileSet.

attributes - The attributes.

Returns:

The ArchiveFileSet.

toDirectories

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

Overrides the parent method, but uses the dirGroupName, dirUserName and dirMode variables to set the mode, userName and groupName inside the returned Directory objects.

Overrides:

toDirectories in class FileSet

Returns:

The set of directories.

Throws:

java.io.IOException - If the build fails.

toFileInfos

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

Description copied from class: FileSet

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.

Overrides:

toFileInfos in class FileSet

Returns:

A List of FileInfo objects for this FileSet.

Throws:

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

withDirGroupName

public ArchiveFileSet withDirGroupName(java.lang.String dirGroupName)

Sets the dirGroupName.

Parameters:

dirGroupName - The dirGroupName.

Returns:

This.

withDirMode

public ArchiveFileSet withDirMode(java.lang.Integer dirMode)

Sets the dirMode.

Parameters:

dirMode - The dirMode.

Returns:

This.

withDirUserName

public ArchiveFileSet withDirUserName(java.lang.String dirUserName)

Sets the dirUserName.

Parameters:

dirUserName - The dirUserName.

Returns:

This.

withGroupName

public ArchiveFileSet withGroupName(java.lang.String groupName)

Sets the groupName.

Parameters:

groupName - The groupName.

Returns:

This.

withMode

public ArchiveFileSet withMode(java.lang.Integer mode)

Sets the mode.

Parameters:

mode - The mode.

Returns:

This.

withPrefix

public ArchiveFileSet withPrefix(java.lang.String prefix)

Sets the prefix.

Parameters:

prefix - The prefix.

Returns:

This.

withUserName

public ArchiveFileSet withUserName(java.lang.String userName)

Sets the userName.

Parameters:

userName - The userName.

Returns:

This.