Top Description Inners Fields Constructors Methods
org.apache.tools.ant.types.optional.depend

public Class ClassfileSet

extends FileSet
Class Inheritance
Imports
java.util.ArrayList, .List, .Stack, .Vector, org.apache.tools.ant.DirectoryScanner, .Project, org.apache.tools.ant.types.FileSet, org.apache.tools.ant.util.StringUtils
A ClassfileSet is a FileSet that enlists all classes that depend on a certain set of root classes. ClassfileSet extends FileSet, its inherited properties defining the domain searched for dependent classes.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
ClassfileSet.ClassRoot

Inner class used to contain info about root classes.

Field Summary

Modifier and TypeField and Description
private List<String>
rootClasses

The list of root classes for this class file set.

private List<FileSet>
rootFileSets

The list of filesets which contain root classes.

Constructor Summary

AccessConstructor and Description
public
ClassfileSet()

Default constructor.

protected
ClassfileSet(ClassfileSet
the other classfileset.
s)

Create a ClassfileSet from another ClassfileSet.

Method Summary

Modifier and TypeMethod and Description
public void
addConfiguredRoot(ClassfileSet.ClassRoot
the configured class root.
root)

Add a nested root class definition to this class file set.

public void
addRootFileset(FileSet
a root file set to be used to search for dependent classes.
rootFileSet)

Add a fileset to which contains a collection of root classes used to drive the search from classes.

public Object

Returns:

a clone of the class file set.
clone()

Overrides org.apache.tools.ant.types.FileSet.clone.

Clone this data type.
protected synchronized void
dieOnCircularReference(Stack<Object>
the stack of references to check.
stk, Project
the project to use to dereference the references.
p)

Overrides org.apache.tools.ant.types.AbstractFileSet.dieOnCircularReference.

Check to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).
public DirectoryScanner

Returns:

a dependency scanner.
getDirectoryScanner(Project
the project used to resolve dirs, etc.
p)

Overrides org.apache.tools.ant.types.AbstractFileSet.getDirectoryScanner.

Return the DirectoryScanner associated with this FileSet.
private ClassfileSet
getRef()

Hides org.apache.tools.ant.types.FileSet.getRef.

public void
setRootClass(String
the name of the root class.
rootClass)

Set the root class attribute.

Inherited from org.apache.tools.ant.types.FileSet:
getRefisFilesystemOnlyiteratorsize

Field Detail

rootClassesback to summary
private List<String> rootClasses

The list of root classes for this class file set. These are the classes which must be included in the fileset and which are the starting point for the dependency search.

rootFileSetsback to summary
private List<FileSet> rootFileSets

The list of filesets which contain root classes.

Constructor Detail

ClassfileSetback to summary
public ClassfileSet()

Default constructor.

ClassfileSetback to summary
protected ClassfileSet(ClassfileSet s)

Create a ClassfileSet from another ClassfileSet.

Parameters
s:ClassfileSet

the other classfileset.

Method Detail

addConfiguredRootback to summary
public void addConfiguredRoot(ClassfileSet.ClassRoot root)

Add a nested root class definition to this class file set.

Parameters
root:ClassfileSet.ClassRoot

the configured class root.

addRootFilesetback to summary
public void addRootFileset(FileSet rootFileSet)

Add a fileset to which contains a collection of root classes used to drive the search from classes.

Parameters
rootFileSet:FileSet

a root file set to be used to search for dependent classes.

cloneback to summary
public Object clone()

Overrides org.apache.tools.ant.types.FileSet.clone.

Clone this data type.

Returns:Object

a clone of the class file set.

Annotations
@Override
dieOnCircularReferenceback to summary
protected synchronized void dieOnCircularReference(Stack<Object> stk, Project p)

Overrides org.apache.tools.ant.types.AbstractFileSet.dieOnCircularReference.

Doc from org.apache.tools.ant.types.DataType.dieOnCircularReference.

Check to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).

If one is included, throw a BuildException created by circularReference.

This implementation is appropriate only for a DataType that cannot hold other DataTypes as children.

The general contract of this method is that it shouldn't do anything if checked is true and set it to true on exit.

Parameters
stk:Stack<Object>

the stack of references to check.

p:Project

the project to use to dereference the references.

Annotations
@Override
getDirectoryScannerback to summary
public DirectoryScanner getDirectoryScanner(Project p)

Overrides org.apache.tools.ant.types.AbstractFileSet.getDirectoryScanner.

Return the DirectoryScanner associated with this FileSet.

Parameters
p:Project

the project used to resolve dirs, etc.

Returns:DirectoryScanner

a dependency scanner.

Annotations
@Override
getRefback to summary
private ClassfileSet getRef()

Hides org.apache.tools.ant.types.FileSet.getRef.

setRootClassback to summary
public void setRootClass(String rootClass)

Set the root class attribute.

Parameters
rootClass:String

the name of the root class.

org.apache.tools.ant.types.optional.depend back to summary

public Class ClassfileSet.ClassRoot

extends Object
Class Inheritance
  • java.lang.Object
  • org.apache.tools.ant.types.optional.depend.ClassfileSet.ClassRoot
Inner class used to contain info about root classes.

Field Summary

Modifier and TypeField and Description
private String
rootClass

The name of the root class

Constructor Summary

AccessConstructor and Description
public
ClassRoot()

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the name of the root class.
getClassname()

Get the name of the root class.

public void
setClassname(String
the name of the root class.
name)

Set the root class name.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

rootClassback to summary
private String rootClass

The name of the root class

Constructor Detail

ClassRootback to summary
public ClassRoot()

Method Detail

getClassnameback to summary
public String getClassname()

Get the name of the root class.

Returns:String

the name of the root class.

setClassnameback to summary
public void setClassname(String name)

Set the root class name.

Parameters
name:String

the name of the root class.