com.izforge.izpack.util.file.types

Class FileSet

java.lang.Object

com.izforge.izpack.util.file.types.DataType

com.izforge.izpack.util.file.types.FileSet

All Implemented Interfaces:

SelectorContainer, Cloneable

Direct Known Subclasses:

DirSet

public class FileSet
extends DataType
implements Cloneable, SelectorContainer

Class that holds an implicit patternset and supports nested patternsets and creates a DirectoryScanner using these patterns.

Common base class for DirSet and FileSet.

Constructor Summary

Constructors

Constructor and Description
FileSet() Construct a new FileSet.

Method Summary

Modifier and Type	Method and Description
void	add(FileSelector selector) Add an arbitary selector.
void	addAnd(AndSelector selector) Add an "And" selector entry on the selector list.
void	addContains(ContainsSelector selector) Add a contains selector entry on the selector list.
void	addContainsRegexp(ContainsRegexpSelector selector) Add a regular expression selector entry on the selector list.
void	addCustom(ExtendSelector selector) Add an extended selector entry on the selector list.
void	addDate(DateSelector selector) Add a selector date entry on the selector list.
void	addDepend(DependSelector selector) Add a depends selector entry on the selector list.
void	addDepth(DepthSelector selector) Add a depth selector entry on the selector list.
void	addDifferent(DifferentSelector selector) Add a DifferentSelector entry on the selector list.
void	addFilename(FilenameSelector selector) Add a selector filename entry on the selector list.
void	addMajority(MajoritySelector selector) Add a majority selector entry on the selector list.
void	addNone(NoneSelector selector) Add a "None" selector entry on the selector list.
void	addNot(NotSelector selector) Add a "Not" selector entry on the selector list.
void	addOr(OrSelector selector) Add an "Or" selector entry on the selector list.
void	addPresent(PresentSelector selector) Add a present selector entry on the selector list.
void	addSize(SizeSelector selector) Add a selector size entry on the selector list.
void	addType(TypeSelector selector) Add a selector type entry on the selector list.
void	appendSelector(FileSelector selector) Add a new selector into this container.
PatternSet.NameEntry	createExclude() Add a name entry to the exclude list.
PatternSet.NameEntry	createInclude() Add a name entry to the include list.
boolean	getDefaultexcludes() Whether default exclusions should be used or not.
File	getDir() Retrieves the base-directory for this instance.
DirectoryScanner	getDirectoryScanner() Returns the directory scanner needed to access the files to process.
FileSelector[]	getSelectors() Returns the set of selectors as an array.
boolean	hasPatterns() Indicates whether there are any patterns here.
boolean	hasSelectors() Indicates whether there are any selectors here.
boolean	isFollowSymlinks() Find out if the fileset wants to follow symbolic links.
int	selectorCount() Gives the count of the number of selectors in this container.
Enumeration<FileSelector>	selectorElements() Returns an enumerator for accessing the set of selectors.
void	setCaseSensitive(boolean isCaseSensitive) Sets case sensitivity of the file system.
void	setDefaultexcludes(boolean useDefaultExcludes) Sets whether default exclusions should be used or not.
void	setDir(File dir) Sets the base-directory for this instance.
void	setExcludes(String excludes) Appends excludes to the current list of exclude patterns.
void	setFile(File file) Creates a single file fileset.
void	setFollowSymlinks(boolean followSymlinks) Sets whether or not symbolic links should be followed.
void	setIncludes(String includes) Appends includes to the current list of include patterns.
void	setupDirectoryScanner(FileScanner ds) Set up the specified directory scanner against the specified project.

Methods inherited from class com.izforge.izpack.util.file.types.DataType

getDescription, isChecked, noChildrenAllowed, setChecked, setDescription, tooManyAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSet

public FileSet()

Construct a new FileSet.

Method Detail

setDir

public void setDir(File dir)
            throws Exception

Sets the base-directory for this instance.

Parameters:

dir - the directory's File instance.

Throws:

Exception

getDir

public File getDir()

Retrieves the base-directory for this instance.

Returns:

File.

createInclude

public PatternSet.NameEntry createInclude()

Add a name entry to the include list.

Returns:

PatternSet.NameEntry.

createExclude

public PatternSet.NameEntry createExclude()

Add a name entry to the exclude list.

Returns:

PatternSet.NameEntry.

setFile

public void setFile(File file)
             throws Exception

Creates a single file fileset.

Parameters:

file - the single File included in this AbstractFileSet.

Throws:

Exception

setIncludes

public void setIncludes(String includes)

Appends includes to the current list of include patterns.

Patterns may be separated by a comma or a space.

Parameters:

includes - the String containing the include patterns.

setExcludes

public void setExcludes(String excludes)

Appends excludes to the current list of exclude patterns.

Patterns may be separated by a comma or a space.

Parameters:

excludes - the String containing the exclude patterns.

setDefaultexcludes

public void setDefaultexcludes(boolean useDefaultExcludes)

Sets whether default exclusions should be used or not.

Parameters:

useDefaultExcludes - boolean.

getDefaultexcludes

public boolean getDefaultexcludes()

Whether default exclusions should be used or not.

setCaseSensitive

public void setCaseSensitive(boolean isCaseSensitive)

Sets case sensitivity of the file system.

Parameters:

isCaseSensitive - boolean.

setFollowSymlinks

public void setFollowSymlinks(boolean followSymlinks)

Sets whether or not symbolic links should be followed.

Parameters:

followSymlinks - whether or not symbolic links should be followed.

isFollowSymlinks

public boolean isFollowSymlinks()

Find out if the fileset wants to follow symbolic links.

Returns:

boolean indicating whether symbolic links should be followed.

Since:

Ant 1.6

getDirectoryScanner

public DirectoryScanner getDirectoryScanner()
                                     throws Exception

Returns the directory scanner needed to access the files to process.

Returns:

a DirectoryScanner instance.

Throws:

Exception

setupDirectoryScanner

public void setupDirectoryScanner(FileScanner ds)

Set up the specified directory scanner against the specified project.

Parameters:

ds - a FileScanner instance.

hasSelectors

public boolean hasSelectors()

Indicates whether there are any selectors here.

Specified by:

hasSelectors in interface SelectorContainer

Returns:

whether any selectors are in this container.

hasPatterns

public boolean hasPatterns()

Indicates whether there are any patterns here.

Returns:

whether any patterns are in this container.

selectorCount

public int selectorCount()

Gives the count of the number of selectors in this container.

Specified by:

selectorCount in interface SelectorContainer

Returns:

the number of selectors in this container as an int.

getSelectors

public FileSelector[] getSelectors()

Returns the set of selectors as an array.

Specified by:

getSelectors in interface SelectorContainer

Returns:

a FileSelector[] of the selectors in this container.

selectorElements

public Enumeration<FileSelector> selectorElements()

Returns an enumerator for accessing the set of selectors.

Specified by:

selectorElements in interface SelectorContainer

Returns:

an Enumeration of selectors.

appendSelector

public void appendSelector(FileSelector selector)

Add a new selector into this container.

Specified by:

appendSelector in interface SelectorContainer

Parameters:

selector - the new FileSelector to add.

addAnd

public void addAnd(AndSelector selector)

Add an "And" selector entry on the selector list.

Specified by:

addAnd in interface SelectorContainer

Parameters:

selector - the AndSelector to add.

addOr

public void addOr(OrSelector selector)

Add an "Or" selector entry on the selector list.

Specified by:

addOr in interface SelectorContainer

Parameters:

selector - the OrSelector to add.

addNot

public void addNot(NotSelector selector)

Add a "Not" selector entry on the selector list.

Specified by:

addNot in interface SelectorContainer

Parameters:

selector - the NotSelector to add.

addNone

public void addNone(NoneSelector selector)

Add a "None" selector entry on the selector list.

Specified by:

addNone in interface SelectorContainer

Parameters:

selector - the NoneSelector to add.

addMajority

public void addMajority(MajoritySelector selector)

Add a majority selector entry on the selector list.

Specified by:

addMajority in interface SelectorContainer

Parameters:

selector - the MajoritySelector to add.

addDate

public void addDate(DateSelector selector)

Add a selector date entry on the selector list.

Specified by:

addDate in interface SelectorContainer

Parameters:

selector - the DateSelector to add.

addSize

public void addSize(SizeSelector selector)

Add a selector size entry on the selector list.

Specified by:

addSize in interface SelectorContainer

Parameters:

selector - the SizeSelector to add.

addDifferent

public void addDifferent(DifferentSelector selector)

Add a DifferentSelector entry on the selector list.

Specified by:

addDifferent in interface SelectorContainer

Parameters:

selector - the DifferentSelector to add.

addFilename

public void addFilename(FilenameSelector selector)

Add a selector filename entry on the selector list.

Specified by:

addFilename in interface SelectorContainer

Parameters:

selector - the FilenameSelector to add.

addType

public void addType(TypeSelector selector)

Add a selector type entry on the selector list.

Specified by:

addType in interface SelectorContainer

Parameters:

selector - the TypeSelector to add.

addCustom

public void addCustom(ExtendSelector selector)

Add an extended selector entry on the selector list.

Specified by:

addCustom in interface SelectorContainer

Parameters:

selector - the ExtendSelector to add.

addContains

public void addContains(ContainsSelector selector)

Add a contains selector entry on the selector list.

Specified by:

addContains in interface SelectorContainer

Parameters:

selector - the ContainsSelector to add.

addPresent

public void addPresent(PresentSelector selector)

Add a present selector entry on the selector list.

Specified by:

addPresent in interface SelectorContainer

Parameters:

selector - the PresentSelector to add.

addDepth

public void addDepth(DepthSelector selector)

Add a depth selector entry on the selector list.

Specified by:

addDepth in interface SelectorContainer

Parameters:

selector - the DepthSelector to add.

addDepend

public void addDepend(DependSelector selector)

Add a depends selector entry on the selector list.

Specified by:

addDepend in interface SelectorContainer

Parameters:

selector - the DependSelector to add.

addContainsRegexp

public void addContainsRegexp(ContainsRegexpSelector selector)

Add a regular expression selector entry on the selector list.

Specified by:

addContainsRegexp in interface SelectorContainer

Parameters:

selector - the ContainsRegexpSelector to add.

add

public void add(FileSelector selector)

Add an arbitary selector.

Specified by:

add in interface SelectorContainer

Parameters:

selector - the FileSelector to add.