org.apache.tools.ant.taskdefs

Class ImportTask

public class ImportTask extends Task

Task to import another build file into the current project.

It must be 'top level'. On execution it will read another Ant file into the same Project.

Important: Trying to understand how relative file references resolved in deep/complex build hierarchies - such as what happens when an imported file imports another file can be difficult. Use absolute references for enhanced build file stability, especially in the imported files.

Examples:

 <import file="../common-targets.xml"/>
 

Import targets from a file in a parent directory.

 <import file="${deploy-platform}.xml"/>
 

Import the project defined by the property deploy-platform.

Since: Ant1.6

UNKNOWN: category="control"

Constructor Summary
ImportTask()
Method Summary
voidadd(ResourceCollection r)
The resource to import.
voidexecute()
protected booleanisInIncludeMode()
Whether the task is in include (as opposed to import) mode.
voidsetAs(String prefix)
The prefix to use when prefixing the imported target names.
voidsetFile(String file)
the name of the file to import.
voidsetOptional(boolean optional)
sets the optional attribute
voidsetPrefixSeparator(String s)
The separator to use between prefix and target name, default is ".".

Constructor Detail

ImportTask

public ImportTask()

Method Detail

add

public void add(ResourceCollection r)
The resource to import.

Since: Ant 1.8.0

execute

public void execute()

isInIncludeMode

protected final boolean isInIncludeMode()
Whether the task is in include (as opposed to import) mode.

In include mode included targets are only known by their prefixed names and their depends lists get rewritten so that all dependencies get the prefix as well.

In import mode imported targets are known by an adorned as well as a prefixed name and the unadorned target may be overwritten in the importing build file. The depends list of the imported targets is not modified at all.

Since: Ant 1.8.0

setAs

public void setAs(String prefix)
The prefix to use when prefixing the imported target names.

Since: Ant 1.8.0

setFile

public void setFile(String file)
the name of the file to import. How relative paths are resolved is still in flux: use absolute paths for safety.

Parameters: file the name of the file

setOptional

public void setOptional(boolean optional)
sets the optional attribute

Parameters: optional if true ignore files that are not present, default is false

setPrefixSeparator

public void setPrefixSeparator(String s)
The separator to use between prefix and target name, default is ".".

Since: Ant 1.8.0