Java Doc for ArchiveFileSet.java in » Build » ANT » org » apache » tools » ant » types » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Build » ANT » org.apache.tools.ant.types

Source Cross Reference Class Diagram Java Document (Java Doc)

org.apache.tools.ant.types .DataType

org.apache.tools.ant.types .AbstractFileSet

org.apache.tools.ant.types .FileSet

org.apache.tools.ant.types .ArchiveFileSet

All known Subclasses:   org.apache.tools.ant.types .TarFileSet,  org.apache.tools.ant.types .ZipFileSet,
ArchiveFileSet
abstract public class ArchiveFileSet extends FileSet (Code)
A ArchiveFileSet is a FileSet with extra attributes useful in the context of archiving tasks. It includes a prefix attribute which is prepended to each entry in the output archive file as well as a fullpath ttribute. It also supports Unix file permissions for files and directories.
since:
   Ant 1.7

Field Summary
final public static int DEFAULT_DIR_MODE
     Default value for the dirmode attribute.
final public static int DEFAULT_FILE_MODE
     Default value for the filemode attribute.

Constructor Summary
public ArchiveFileSet()

protected ArchiveFileSet(FileSet fileset)
     Constructor using a fileset arguement.
protected ArchiveFileSet(ArchiveFileSet fileset)
     Constructor using a archive fileset arguement.

Method Summary
public void addConfigured(ResourceCollection a)
     Set the source Archive file for the archivefileset.
public Object clone()
     Return a ArchiveFileSet that has the same properties as this one.
protected void configureFileSet(ArchiveFileSet zfs)

public int getDirMode(Project p)

public int getDirMode()

public DirectoryScanner getDirectoryScanner(Project p)
     Return the DirectoryScanner associated with this FileSet.
public int getFileMode(Project p)

public int getFileMode()

public String getFullpath(Project p)
     Return the full pathname of the single entry in this fileset.
public String getFullpath()
     Return the full pathname of the single entryZ in this fileset.
public String getPrefix(Project p)
     Return the prefix prepended to entries in the archive file.
public String getPrefix()
     Return the prefix prepended to entries in the archive file.
public File getSrc(Project p)
     Get the archive from which entries will be extracted.
public File getSrc()
     Get the archive file from which entries will be extracted.
public boolean hasDirModeBeenSet()
     Whether the user has specified the mode explicitly.
public boolean hasFileModeBeenSet()
     Whether the user has specified the mode explicitly.
public void integerSetDirMode(int mode)

public void integerSetFileMode(int mode)

public boolean isFilesystemOnly()
     Indicate whether this ResourceCollection is composed entirely of Resources accessible via local filesystem conventions.
public Iterator iterator()
     Fulfill the ResourceCollection contract.
abstract protected ArchiveScanner newArchiveScanner()
     Creates a scanner for this type of archive.
public void setDir(File dir)
     Set the directory for the fileset.
public void setDirMode(String octalString)

public void setFileMode(String octalString)

public void setFullpath(String fullpath)
     Set the full pathname of the single entry in this fileset.
public void setPrefix(String prefix)
     Prepend this prefix to the path for each archive entry.
public void setSrc(File srcFile)
     Set the source Archive file for the archivefileset.
public void setSrcResource(Resource src)
     Set the source Archive file for the archivefileset.
public int size()
     Fulfill the ResourceCollection contract.
public String toString()
     for file based zipfilesets, return the same as for normal filesets else just return the path of the zip for file based archivefilesets, included files as a listof semicolon-separated filenames.

Field Detail
DEFAULT_DIR_MODE
final public static int DEFAULT_DIR_MODE(Code)
Default value for the dirmode attribute.
since:
   Ant 1.5.2

DEFAULT_FILE_MODE
final public static int DEFAULT_FILE_MODE(Code)
Default value for the filemode attribute.
since:
   Ant 1.5.2

Constructor Detail
ArchiveFileSet
public ArchiveFileSet()(Code)
Constructor for ArchiveFileSet

ArchiveFileSet
protected ArchiveFileSet(FileSet fileset)(Code)
Constructor using a fileset arguement.
Parameters:
  fileset - the fileset to use

ArchiveFileSet
protected ArchiveFileSet(ArchiveFileSet fileset)(Code)
Constructor using a archive fileset arguement.
Parameters:
  fileset - the archivefileset to use

Method Detail
addConfigured
public void addConfigured(ResourceCollection a)(Code)
Set the source Archive file for the archivefileset. Prevents both "dir" and "src" from being specified.
Parameters:
  a - the archive as a single element Resource collection.

clone
public Object clone()(Code)
Return a ArchiveFileSet that has the same properties as this one. the cloned archiveFileSet
since:
   Ant 1.6

configureFileSet
protected void configureFileSet(ArchiveFileSet zfs)(Code)
A ArchiveFileset accepts another ArchiveFileSet or a FileSet as reference FileSets are often used by the war task for the lib attribute
Parameters:
  zfs - the project to use

getDirMode
public int getDirMode(Project p)(Code)
Get the dir mode of the archive fileset
Parameters:
  p - the project to use the mode

getDirMode
public int getDirMode()(Code)
the dir mode.

getDirectoryScanner
public DirectoryScanner getDirectoryScanner(Project p)(Code)
Return the DirectoryScanner associated with this FileSet. If the ArchiveFileSet defines a source Archive file, then a ArchiveScanner is returned instead.
Parameters:
  p - the project to use a directory scanner

getFileMode
public int getFileMode(Project p)(Code)
Get the mode of the archive fileset
Parameters:
  p - the project to use the mode

getFileMode
public int getFileMode()(Code)
the file mode.

getFullpath
public String getFullpath(Project p)(Code)
Return the full pathname of the single entry in this fileset.
Parameters:
  p - the project to use the full path

getFullpath
public String getFullpath()(Code)
Return the full pathname of the single entryZ in this fileset. the full pathname.

getPrefix
public String getPrefix(Project p)(Code)
Return the prefix prepended to entries in the archive file.
Parameters:
  p - the project to use the prefix

getPrefix
public String getPrefix()(Code)
Return the prefix prepended to entries in the archive file. the prefix.

getSrc
public File getSrc(Project p)(Code)
Get the archive from which entries will be extracted.
Parameters:
  p - the project to use the source file

getSrc
public File getSrc()(Code)
Get the archive file from which entries will be extracted. the archive in case the archive is a file, null otherwise.

hasDirModeBeenSet
public boolean hasDirModeBeenSet()(Code)
Whether the user has specified the mode explicitly. true if it has been set

hasFileModeBeenSet
public boolean hasFileModeBeenSet()(Code)
Whether the user has specified the mode explicitly. true if it has been set

integerSetDirMode
public void integerSetDirMode(int mode)(Code)
specify the user, group and other modes in the standard Unix fashion; optional, default=0755
We use the strange name so this method doesn't appear in IntrospectionHelpers list of attribute setters.

Parameters:
  mode - a int value
since:
   Ant 1.7

integerSetFileMode
public void integerSetFileMode(int mode)(Code)
specify the user, group and other modes in the standard Unix fashion; optional, default=0644
We use the strange name so this method doesn't appear in IntrospectionHelpers list of attribute setters.

Parameters:
  mode - a int value
since:
   Ant 1.7

isFilesystemOnly
public boolean isFilesystemOnly()(Code)
Indicate whether this ResourceCollection is composed entirely of Resources accessible via local filesystem conventions. If true, all Resources returned from this ResourceCollection should be instances of FileResource. whether this is a filesystem-only resource collection.
since:
   Ant 1.7

iterator
public Iterator iterator()(Code)
Fulfill the ResourceCollection contract. Iterator of Resources.
since:
   Ant 1.7

newArchiveScanner
abstract protected ArchiveScanner newArchiveScanner()(Code)
Creates a scanner for this type of archive. the scanner.

setDir
public void setDir(File dir) throws BuildException(Code)
Set the directory for the fileset.
Parameters:
  dir - the directory for the fileset
throws:
  BuildException - on error

setDirMode
public void setDirMode(String octalString)(Code)
A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion; optional, default=0755
Parameters:
  octalString - a String value

setFileMode
public void setFileMode(String octalString)(Code)
A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion; optional, default=0644
Parameters:
  octalString - a String value

setFullpath
public void setFullpath(String fullpath)(Code)
Set the full pathname of the single entry in this fileset. Prevents both prefix and fullpath from being specified
Parameters:
  fullpath - the full pathname of the single entry in this fileset.

setPrefix
public void setPrefix(String prefix)(Code)
Prepend this prefix to the path for each archive entry. Prevents both prefix and fullpath from being specified
Parameters:
  prefix - The prefix to prepend to entries in the archive file.

setSrc
public void setSrc(File srcFile)(Code)
Set the source Archive file for the archivefileset. Prevents both "dir" and "src" from being specified.
Parameters:
  srcFile - The archive from which to extract entries.

setSrcResource
public void setSrcResource(Resource src)(Code)
Set the source Archive file for the archivefileset. Prevents both "dir" and "src" from being specified.
Parameters:
  src - The archive from which to extract entries.

size
public int size()(Code)
Fulfill the ResourceCollection contract. size of the collection as int.
since:
   Ant 1.7

toString
public String toString()(Code)
for file based zipfilesets, return the same as for normal filesets else just return the path of the zip for file based archivefilesets, included files as a listof semicolon-separated filenames. else just the name of the zip.

Methods inherited from org.apache.tools.ant.types.FileSet
public Object clone()(Code)(Java Doc)
public boolean isFilesystemOnly()(Code)(Java Doc)
public Iterator iterator()(Code)(Java Doc)
public int size()(Code)(Java Doc)

Methods inherited from org.apache.tools.ant.types.AbstractFileSet
public void add(FileSelector selector)(Code)(Java Doc)
public void addAnd(AndSelector selector)(Code)(Java Doc)
public void addContains(ContainsSelector selector)(Code)(Java Doc)
public void addContainsRegexp(ContainsRegexpSelector selector)(Code)(Java Doc)
public void addCustom(ExtendSelector selector)(Code)(Java Doc)
public void addDate(DateSelector selector)(Code)(Java Doc)
public void addDepend(DependSelector selector)(Code)(Java Doc)
public void addDepth(DepthSelector selector)(Code)(Java Doc)
public void addDifferent(DifferentSelector selector)(Code)(Java Doc)
public void addFilename(FilenameSelector selector)(Code)(Java Doc)
public void addMajority(MajoritySelector selector)(Code)(Java Doc)
public void addModified(ModifiedSelector selector)(Code)(Java Doc)
public void addNone(NoneSelector selector)(Code)(Java Doc)
public void addNot(NotSelector selector)(Code)(Java Doc)
public void addOr(OrSelector selector)(Code)(Java Doc)
public void addPresent(PresentSelector selector)(Code)(Java Doc)
public void addSelector(SelectSelector selector)(Code)(Java Doc)
public void addSize(SizeSelector selector)(Code)(Java Doc)
public void addType(TypeSelector selector)(Code)(Java Doc)
public synchronized void appendExcludes(String[] excludes)(Code)(Java Doc)
public synchronized void appendIncludes(String[] includes)(Code)(Java Doc)
public synchronized void appendSelector(FileSelector selector)(Code)(Java Doc)
public synchronized Object clone()(Code)(Java Doc)
public synchronized PatternSet.NameEntry createExclude()(Code)(Java Doc)
public synchronized PatternSet.NameEntry createExcludesFile()(Code)(Java Doc)
public synchronized PatternSet.NameEntry createInclude()(Code)(Java Doc)
public synchronized PatternSet.NameEntry createIncludesFile()(Code)(Java Doc)
public synchronized PatternSet createPatternSet()(Code)(Java Doc)
public synchronized boolean getDefaultexcludes()(Code)(Java Doc)
public File getDir()(Code)(Java Doc)
public synchronized File getDir(Project p)(Code)(Java Doc)
public DirectoryScanner getDirectoryScanner()(Code)(Java Doc)
public DirectoryScanner getDirectoryScanner(Project p)(Code)(Java Doc)
protected AbstractFileSet getRef(Project p)(Code)(Java Doc)
public synchronized FileSelector[] getSelectors(Project p)(Code)(Java Doc)
public synchronized boolean hasPatterns()(Code)(Java Doc)
public synchronized boolean hasSelectors()(Code)(Java Doc)
public synchronized boolean isCaseSensitive()(Code)(Java Doc)
public synchronized boolean isFollowSymlinks()(Code)(Java Doc)
public String[] mergeExcludes(Project p)(Code)(Java Doc)
public String[] mergeIncludes(Project p)(Code)(Java Doc)
public synchronized PatternSet mergePatterns(Project p)(Code)(Java Doc)
public synchronized int selectorCount()(Code)(Java Doc)
public synchronized Enumeration selectorElements()(Code)(Java Doc)
public synchronized void setCaseSensitive(boolean caseSensitive)(Code)(Java Doc)
public synchronized void setDefaultexcludes(boolean useDefaultExcludes)(Code)(Java Doc)
public synchronized void setDir(File dir) throws BuildException(Code)(Java Doc)
public synchronized void setExcludes(String excludes)(Code)(Java Doc)
public synchronized void setExcludesfile(File excl) throws BuildException(Code)(Java Doc)
public synchronized void setFile(File file)(Code)(Java Doc)
public synchronized void setFollowSymlinks(boolean followSymlinks)(Code)(Java Doc)
public synchronized void setIncludes(String includes)(Code)(Java Doc)
public synchronized void setIncludesfile(File incl) throws BuildException(Code)(Java Doc)
public void setRefid(Reference r) throws BuildException(Code)(Java Doc)
public void setupDirectoryScanner(FileScanner ds)(Code)(Java Doc)
public synchronized void setupDirectoryScanner(FileScanner ds, Project p)(Code)(Java Doc)
public String toString()(Code)(Java Doc)

Fields inherited from org.apache.tools.ant.types.DataType
protected boolean checked(Code)(Java Doc)
protected Reference ref(Code)(Java Doc)

Methods inherited from org.apache.tools.ant.types.DataType
protected void checkAttributesAllowed()(Code)(Java Doc)
protected void checkChildrenAllowed()(Code)(Java Doc)
protected BuildException circularReference()(Code)(Java Doc)
public Object clone() throws CloneNotSupportedException(Code)(Java Doc)
protected void dieOnCircularReference()(Code)(Java Doc)
protected void dieOnCircularReference(Project p)(Code)(Java Doc)
protected void dieOnCircularReference(Stack stack, Project project) throws BuildException(Code)(Java Doc)
protected Object getCheckedRef()(Code)(Java Doc)
protected Object getCheckedRef(Project p)(Code)(Java Doc)
protected Object getCheckedRef(Class requiredClass, String dataTypeName)(Code)(Java Doc)
protected Object getCheckedRef(Class requiredClass, String dataTypeName, Project project)(Code)(Java Doc)
protected String getDataTypeName()(Code)(Java Doc)
public Reference getRefid()(Code)(Java Doc)
public static void invokeCircularReferenceCheck(DataType dt, Stack stk, Project p)(Code)(Java Doc)
protected boolean isChecked()(Code)(Java Doc)
public boolean isReference()(Code)(Java Doc)
protected BuildException noChildrenAllowed()(Code)(Java Doc)
protected void setChecked(boolean checked)(Code)(Java Doc)
public void setRefid(Reference ref)(Code)(Java Doc)
public String toString()(Code)(Java Doc)
protected BuildException tooManyAttributes()(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.