Class Depend

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.MatchingTask

org.apache.tools.ant.taskdefs.optional.depend.Depend

All Implemented Interfaces:

Cloneable, SelectorContainer

public class Depend
extends MatchingTask

Generates a dependency file for a given set of classes.

Field Summary

Fields inherited from class MatchingTask

fileset

Modifier and Type	Field	Description
protected FileSet	fileset

Fields inherited from class Task

target, taskName, taskType, wrapper

Modifier and Type	Field	Description
protected Target	target	Deprecated. since 1.6.x.
protected String	taskName	Deprecated. since 1.6.x.
protected String	taskType	Deprecated. since 1.6.x.
protected RuntimeConfigurable	wrapper	Deprecated. since 1.6.x.

Fields inherited from class ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Constructor	Description
Depend()

Method Summary

Modifier and Type	Method	Description
Path	createClasspath()	Adds a classpath to be used for this dependency check.
void	execute()	Does the work.
Path	getClasspath()	Gets the classpath to be used for this dependency check.
protected void	scanDir(File srcDir, String[] files)	Scans the directory looking for source files that are newer than their class files.
void	setCache(File cache)	Sets the dependency cache file.
void	setClasspath(Path classpath)	Set the classpath to be used for this dependency check.
void	setClasspathRef(Reference r)	Adds a reference to a classpath defined elsewhere.
void	setClosure(boolean closure)	If true, transitive dependencies are followed until the closure of the dependency set if reached.
void	setDestDir(Path destPath)	Set the destination directory where the compiled Java files exist.
void	setDump(boolean dump)	If true, the dependency information will be written to the debug level log.
void	setSrcdir(Path srcPath)	Set the directories path to find the Java source files.
void	setWarnOnRmiStubs(boolean warnOnRmiStubs)	Flag to set to true if you want dependency issues with RMI stubs to appear at warning level.

Methods inherited from class MatchingTask

add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems

Modifier and Type	Method	Description
void	add(FileSelector selector)	add an arbitrary 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 type selector entry on the type 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	addModified(ModifiedSelector selector)	add the modified selector
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	addSelector(SelectSelector selector)	add a "Select" 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 type selector entry on the type list
void	appendSelector(FileSelector selector)	Add a new selector into this container.
PatternSet.NameEntry	createExclude()	add a name entry on the exclude list
PatternSet.NameEntry	createExcludesFile()	add a name entry on the include files list
PatternSet.NameEntry	createInclude()	add a name entry on the include list
PatternSet.NameEntry	createIncludesFile()	add a name entry on the include files list
PatternSet	createPatternSet()	add a set of patterns
protected DirectoryScanner	getDirectoryScanner(File baseDir)	Returns the directory scanner needed to access the files to process.
protected final FileSet	getImplicitFileSet()	Accessor for the implicit fileset.
FileSelector[]	getSelectors(Project p)	Returns the set of selectors as an array.
boolean	hasSelectors()	Indicates whether there are any selectors here.
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	setExcludes(String excludes)	Sets the set of exclude patterns.
void	setExcludesfile(File excludesfile)	Sets the name of the file containing the includes patterns.
void	setFollowSymlinks(boolean followSymlinks)	Sets whether or not symbolic links or Windows junctions should be followed.
void	setIncludes(String includes)	Sets the set of include patterns.
void	setIncludesfile(File includesfile)	Sets the name of the file containing the includes patterns.
void	setProject(Project project)	Sets the project object of this component.
void	XsetIgnore(String ignoreString)	List of filenames and directory names to not include.
void	XsetItems(String itemString)	Set this to be the items in the base directory that you want to be included.

Methods inherited from class Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Modifier and Type	Method	Description
final void	bindToOwner(Task owner)	Bind a task to another; use this when configuring a newly created task to do work on behalf of another.
Target	getOwningTarget()	Returns the container target of this task.
RuntimeConfigurable	getRuntimeConfigurableWrapper()	Returns the wrapper used for runtime configuration.
String	getTaskName()	Returns the name to use in logging messages.
String	getTaskType()	Return the type of task.
protected RuntimeConfigurable	getWrapper()	Return the runtime configurable structure for this task.
protected void	handleErrorFlush(String output)	Handles an error line by logging it with the WARN priority.
protected void	handleErrorOutput(String output)	Handles an error output by logging it with the WARN priority.
protected void	handleFlush(String output)	Handles output by logging it with the INFO priority.
protected int	handleInput(byte[] buffer, int offset, int length)	Handle an input request by this task.
protected void	handleOutput(String output)	Handles output by logging it with the INFO priority.
void	init()	Called by the project to let the task initialize properly.
protected final boolean	isInvalid()	Has this task been marked invalid?
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	log(String msg, Throwable t, int msgLevel)	Logs a message with the given priority.
void	log(Throwable t, int msgLevel)	Logs a message with the given priority.
void	maybeConfigure()	Configures this task - if it hasn't been done already.
final void	perform()	Performs this task if it's still valid, or gets a replacement version and performs that otherwise.
void	reconfigure()	Force the task to be reconfigured from its RuntimeConfigurable.
void	setOwningTarget(Target target)	Sets the target container of this task.
void	setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)	Sets the wrapper to be used for runtime configuration.
void	setTaskName(String name)	Sets the name to use in logging messages.
void	setTaskType(String type)	Sets the name with which the task has been invoked.

Methods inherited from class ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation

Modifier and Type	Method	Description
Object	clone()
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.

Methods inherited from class Object

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

Constructor Details

Depend

public Depend()

Method Details

setClasspath

public void setClasspath(Path classpath)

Set the classpath to be used for this dependency check.

Parameters:

classpath - the classpath to be used when checking for dependencies on elements in the classpath

getClasspath

public Path getClasspath()

Gets the classpath to be used for this dependency check.

Returns:

the current dependency classpath

createClasspath

public Path createClasspath()

Adds a classpath to be used for this dependency check.

Returns:

A path object to be configured by Ant

setClasspathRef

public void setClasspathRef(Reference r)

Adds a reference to a classpath defined elsewhere.

Parameters:

r - a reference to a path object to be used as the depend classpath

setWarnOnRmiStubs

public void setWarnOnRmiStubs(boolean warnOnRmiStubs)

Flag to set to true if you want dependency issues with RMI stubs to appear at warning level.

Parameters:

warnOnRmiStubs - if true set dependency issues to appear at warning level.

Since:

Ant1.7

execute

public void execute()
             throws BuildException

Does the work.

Overrides:

execute in class Task

Throws:

BuildException - Thrown in case of an unrecoverable error.

scanDir

protected void scanDir(File srcDir,
 String[] files)

Scans the directory looking for source files that are newer than their class files. The results are returned in the class variable compileList

Parameters:

srcDir - the source directory

files - the names of the files in the source dir which are to be checked.

setSrcdir

public void setSrcdir(Path srcPath)

Set the directories path to find the Java source files.

Parameters:

srcPath - the source path

setDestDir

public void setDestDir(Path destPath)

Set the destination directory where the compiled Java files exist.

Parameters:

destPath - the destination areas where build files are written

setCache

public void setCache(File cache)

Sets the dependency cache file.

Parameters:

cache - the dependency cache file

setClosure

public void setClosure(boolean closure)

If true, transitive dependencies are followed until the closure of the dependency set if reached. When not set, the depend task will only follow direct dependencies between classes.

Parameters:

closure - indicate if dependency closure is required.

setDump

public void setDump(boolean dump)

If true, the dependency information will be written to the debug level log.

Parameters:

dump - set to true to dump dependency information to the log