Package org.codehaus.plexus.archiver.util

Class DefaultFileSet

java.lang.Object

org.codehaus.plexus.archiver.util.AbstractFileSet<DefaultFileSet>

org.codehaus.plexus.archiver.util.DefaultFileSet

All Implemented Interfaces:

BaseFileSet, FileSet

public class DefaultFileSet
extends AbstractFileSet<DefaultFileSet>
implements FileSet

Default implementation of FileSet.

Since:

1.0-alpha-9

Constructor Summary

Constructors

Constructor	Description
DefaultFileSet()
DefaultFileSet(java.io.File directory)

Method Summary

Modifier and Type	Method	Description
static DefaultFileSet	fileSet(java.io.File directory)
DefaultFileSet	followingSymLinks(boolean followingSymLinks)
java.io.File	getDirectory()	Returns the file sets base directory.
boolean	isFollowingSymLinks()	Returns whether symbolic links below the base directory are followed.
void	setDirectory(java.io.File directory)	Sets the file sets base directory.
void	setFollowingSymLinks(boolean followingSymLinks)	Sets whether symbolic links below the base directory are followed.

Methods inherited from class org.codehaus.plexus.archiver.util.AbstractFileSet

exclude, getExcludes, getFileMappers, getFileSelectors, getIncludes, getPrefix, getStreamTransformer, include, includeEmptyDirs, includeExclude, isCaseSensitive, isIncludingEmptyDirectories, isUsingDefaultExcludes, prefixed, setCaseSensitive, setExcludes, setFileMappers, setFileSelectors, setIncludes, setIncludingEmptyDirectories, setPrefix, setStreamTransformer, setUsingDefaultExcludes, usingDefaultExcludes

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.codehaus.plexus.archiver.BaseFileSet

getExcludes, getFileMappers, getFileSelectors, getIncludes, getPrefix, getStreamTransformer, isCaseSensitive, isIncludingEmptyDirectories, isUsingDefaultExcludes

Constructor Detail

DefaultFileSet

public DefaultFileSet(java.io.File directory)

DefaultFileSet

public DefaultFileSet()

Method Detail

setDirectory

public void setDirectory(@Nonnull
                         java.io.File directory)

Sets the file sets base directory.

getDirectory

@Nonnull
public java.io.File getDirectory()

Description copied from interface: FileSet

Returns the file sets base directory.

Specified by:

getDirectory in interface FileSet

setFollowingSymLinks

public void setFollowingSymLinks(boolean followingSymLinks)

Sets whether symbolic links below the base directory are followed. Defaults to false.

Since:

4.14.0

isFollowingSymLinks

public boolean isFollowingSymLinks()

Description copied from interface: FileSet

Returns whether symbolic links below the base directory are followed.

When false (the default), a symbolic link is added to the archive as a link and the contents of a linked directory are not scanned. When true, links are resolved: a linked directory is added as a directory and its target's contents are included.

Following links means the scan can descend into a directory that links back to one of its own ancestors, so only enable it for trees known not to contain such cycles.

Specified by:

isFollowingSymLinks in interface FileSet

followingSymLinks

public DefaultFileSet followingSymLinks(boolean followingSymLinks)

Since:

4.14.0

fileSet

public static DefaultFileSet fileSet(java.io.File directory)