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: we have not finalized how relative file references will be resolved in deep/complex build hierarchies -such as what happens when an imported file imports another file. 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

Field Summary

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Method Summary

void
execute()
This relies on the task order model.
void
setFile(String file)
the name of the file to import.
void
setOptional(boolean optional)
sets the optional attribute

Methods inherited from class org.apache.tools.ant.Task

execute, getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Method Details

execute

public void execute()
This relies on the task order model.
Overrides:
execute in interface Task

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

Copyright B) 2000-2007 Apache Software Foundation. All Rights Reserved.