Apache Ant Core 1.10.14 · org.apache.tools.ant.taskdefs.ImportTask

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 Note

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.

Field Summary

Modifier and Type	Field and Description
private String	file
private static final FileUtils	FILE_UTILS
private boolean	optional
private String	prefixSeparator
private final Union	resources
private String	targetPrefix

Inherited from org.apache.tools.ant.Task:: target taskName taskType wrapper

Constructor Summary

Access	Constructor and Description
public	ImportTask()

Method Summary

Modifier and Type	Method and Description
public void	add(ResourceCollection ResourceCollection r) The resource to import.
public void	execute() Overrides org.apache.tools.ant.Task.execute. Called by the project to let the task do its work.
private Resource	getFileAttributeResource()
private boolean	hasAlreadyBeenImported(Resource importedResource, Vector<Object> importStack)
private void	importResource(ProjectHelper helper, Resource importedResource)
private boolean	isExistingAbsoluteFile(String name)
protected final boolean	Returns: boolean isInIncludeMode() Whether the task is in include (as opposed to import) mode.
private boolean	isOneOf(Object o, Resource importedResource, File importedFile, URL importedURL)
public void	setAs(String String prefix) The prefix to use when prefixing the imported target names.
public void	setFile(String the name of the file file) the name of the file to import.
public void	setOptional(boolean if true ignore files that are not present, default is false optional) sets the optional attribute
public void	setPrefixSeparator(String String s) The separator to use between prefix and target name, default is ".".
private static void	setProjectHelperProps(String String prefix, String String prefixSep, boolean boolean inIncludeMode) Sets a bunch of Thread-local ProjectHelper properties.

Field Detail

file	back to summary
private String file

FILE_UTILS	back to summary
private static final FileUtils FILE_UTILS

optional	back to summary
private boolean optional

prefixSeparator	back to summary
private String prefixSeparator

resources	back to summary
private final Union resources

targetPrefix	back to summary
private String targetPrefix

Constructor Detail

ImportTask	back to summary
public ImportTask()

Method Detail

add	back to summary
public void add(ResourceCollection r) The resource to import. Parameters r:ResourceCollection ResourceCollection Since Ant 1.8.0

add

back to summary

public void add(ResourceCollection r)

The resource to import.

Parameters

r:ResourceCollection: ResourceCollection

Since

Ant 1.8.0

execute	back to summary
public void execute() Overrides org.apache.tools.ant.Task.execute. Doc from org.apache.tools.ant.Task.execute. Called by the project to let the task do its work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running "ant target1 target2" will run all tasks in target3 twice. Annotations @Override

execute

back to summary

public void execute()

Overrides org.apache.tools.ant.Task.execute.

Doc from org.apache.tools.ant.Task.execute.

Called by the project to let the task do its work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running "ant target1 target2" will run all tasks in target3 twice.

Annotations

@Override

getFileAttributeResource	back to summary
private Resource getFileAttributeResource()

hasAlreadyBeenImported	back to summary
private boolean hasAlreadyBeenImported(Resource importedResource, Vector<Object> importStack)

importResource	back to summary
private void importResource(ProjectHelper helper, Resource importedResource)

isExistingAbsoluteFile	back to summary
private boolean isExistingAbsoluteFile(String name)

isInIncludeMode	back to summary
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. Returns:boolean boolean Since Ant 1.8.0

isInIncludeMode

back to summary

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.

Returns:boolean: boolean
Since: Ant 1.8.0

isOneOf	back to summary
private boolean isOneOf(Object o, Resource importedResource, File importedFile, URL importedURL)

setAs	back to summary
public void setAs(String prefix) The prefix to use when prefixing the imported target names. Parameters prefix:String String Since Ant 1.8.0

setAs

back to summary

public void setAs(String prefix)

The prefix to use when prefixing the imported target names.

Parameters

prefix:String: String

Since

Ant 1.8.0

setFile	back to summary
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:String the name of the file

setFile

back to summary

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:String: the name of the file

setOptional	back to summary
public void setOptional(boolean optional) sets the optional attribute Parameters optional:boolean if true ignore files that are not present, default is false

setOptional

back to summary

public void setOptional(boolean optional)

sets the optional attribute

Parameters

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

setPrefixSeparator	back to summary
public void setPrefixSeparator(String s) The separator to use between prefix and target name, default is ".". Parameters s:String String Since Ant 1.8.0

setPrefixSeparator

back to summary

public void setPrefixSeparator(String s)

The separator to use between prefix and target name, default is ".".

Parameters

s:String: String

Since

Ant 1.8.0

setProjectHelperProps	back to summary
private static void setProjectHelperProps(String prefix, String prefixSep, boolean inIncludeMode) Sets a bunch of Thread-local ProjectHelper properties. Parameters prefix:String String prefixSep:String String inIncludeMode:boolean boolean Since Ant 1.8.0

setProjectHelperProps

back to summary

private static void setProjectHelperProps(String prefix, String prefixSep, boolean inIncludeMode)

Sets a bunch of Thread-local ProjectHelper properties.

Parameters

prefix:String: String
prefixSep:String: String
inIncludeMode:boolean: boolean

Since

Ant 1.8.0

public Class ImportTask

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail