|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.tools.ant.Project
Central representation of an Ant project. This class defines a Ant project with all of it's targets and tasks. It also provides the mechanism to kick off a build using a particular target name.
This class also encapsulates methods which allow Files to be refered to using abstract path names which are translated to native system file paths at runtime as well as defining various project properties.
Field Summary | |
protected Target |
currentTarget
|
protected Task |
currentTask
|
static java.lang.String |
JAVA_1_0
|
static java.lang.String |
JAVA_1_1
|
static java.lang.String |
JAVA_1_2
|
static java.lang.String |
JAVA_1_3
|
static int |
MSG_ERR
|
static int |
MSG_INFO
|
static int |
MSG_VERBOSE
|
static int |
MSG_WARN
|
static java.lang.String |
TOKEN_END
|
static java.lang.String |
TOKEN_START
|
Constructor Summary | |
Project()
|
Method Summary | |
void |
addBuildListener(BuildListener listener)
|
void |
addFilter(java.lang.String token,
java.lang.String value)
|
void |
addOrReplaceTarget(java.lang.String targetName,
Target target)
|
void |
addOrReplaceTarget(Target target)
|
void |
addReference(java.lang.String name,
java.lang.Object value)
|
void |
addTarget(java.lang.String targetName,
Target target)
This call expects to add a new Target. |
void |
addTarget(Target target)
This call expects to add a new Target. |
void |
addTaskDefinition(java.lang.String taskName,
java.lang.Class taskClass)
|
void |
copyFile(java.io.File sourceFile,
java.io.File destFile)
Convienence method to copy a file from a source to a destination. |
void |
copyFile(java.io.File sourceFile,
java.io.File destFile,
boolean filtering)
Convienence method to copy a file from a source to a destination specifying if token filtering must be used. |
void |
copyFile(java.lang.String sourceFile,
java.lang.String destFile)
Convienence method to copy a file from a source to a destination. |
void |
copyFile(java.lang.String sourceFile,
java.lang.String destFile,
boolean filtering)
Convienence method to copy a file from a source to a destination specifying if token filtering must be used. |
BuildEvent |
createBuildEvent()
|
BuildEvent |
createBuildEvent(java.lang.String msg,
int priority)
|
BuildEvent |
createBuildEvent(java.lang.Throwable exception)
|
Task |
createTask(java.lang.String taskType)
|
void |
executeTarget(java.lang.String targetName)
|
void |
executeTargets(java.util.Vector targetNames)
|
protected void |
fireBuildFinished(java.lang.Throwable exception)
|
protected void |
fireBuildStarted()
|
protected void |
fireMessageLogged(java.lang.String message,
int priority)
|
protected void |
fireTargetFinished(java.lang.Throwable exception)
|
protected void |
fireTargetStarted()
|
protected void |
fireTaskFinished(java.lang.Throwable exception)
|
protected void |
fireTaskStarted()
|
java.io.File |
getBaseDir()
|
java.util.Vector |
getBuildListeners()
|
java.lang.String |
getDefaultTarget()
|
java.util.Hashtable |
getFilters()
|
static java.lang.String |
getJavaVersion()
|
java.lang.String |
getName()
|
java.util.Hashtable |
getProperties()
|
java.lang.String |
getProperty(java.lang.String name)
|
java.util.Hashtable |
getReferences()
|
java.util.Hashtable |
getTargets()
|
java.util.Hashtable |
getUserProperties()
|
java.lang.String |
getUserProperty(java.lang.String name)
|
void |
init()
Initialise the project. |
void |
log(java.lang.String msg)
|
void |
log(java.lang.String msg,
int msgLevel)
|
void |
log(java.lang.String msg,
java.lang.String tag,
int msgLevel)
|
void |
removeBuildListener(BuildListener listener)
|
java.io.File |
resolveFile(java.lang.String fileName)
|
void |
setBaseDir(java.io.File baseDir)
|
void |
setBasedir(java.lang.String baseD)
|
void |
setDefault(java.lang.String defaultTarget)
|
void |
setDefaultTarget(java.lang.String defaultTarget)
|
void |
setName(java.lang.String name)
|
void |
setProperty(java.lang.String name,
java.lang.String value)
|
void |
setUserProperty(java.lang.String name,
java.lang.String value)
|
static boolean |
toBoolean(java.lang.String s)
returns the boolean equivalent of a string, which is considered true if either "on", "true", or "yes" is found, ignoring case. |
java.lang.String |
translatePath(java.lang.String to_process)
Translate a path into its native (platform specific) path. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
public static final int MSG_ERR
public static final int MSG_WARN
public static final int MSG_INFO
public static final int MSG_VERBOSE
public static final java.lang.String JAVA_1_0
public static final java.lang.String JAVA_1_1
public static final java.lang.String JAVA_1_2
public static final java.lang.String JAVA_1_3
public static final java.lang.String TOKEN_START
public static final java.lang.String TOKEN_END
protected Target currentTarget
protected Task currentTask
Constructor Detail |
public Project()
Method Detail |
public void init() throws BuildException
public void addBuildListener(BuildListener listener)
public void removeBuildListener(BuildListener listener)
public java.util.Vector getBuildListeners()
public void log(java.lang.String msg)
public void log(java.lang.String msg, int msgLevel)
public void log(java.lang.String msg, java.lang.String tag, int msgLevel)
public void setProperty(java.lang.String name, java.lang.String value)
public void setUserProperty(java.lang.String name, java.lang.String value)
public java.lang.String getProperty(java.lang.String name)
public java.lang.String getUserProperty(java.lang.String name)
public java.util.Hashtable getProperties()
public java.util.Hashtable getUserProperties()
public void setDefaultTarget(java.lang.String defaultTarget)
public java.lang.String getDefaultTarget()
public void setDefault(java.lang.String defaultTarget)
public void setName(java.lang.String name)
public java.lang.String getName()
public void addFilter(java.lang.String token, java.lang.String value)
public java.util.Hashtable getFilters()
public void setBasedir(java.lang.String baseD) throws BuildException
public void setBaseDir(java.io.File baseDir)
public java.io.File getBaseDir()
public static java.lang.String getJavaVersion()
public void addTaskDefinition(java.lang.String taskName, java.lang.Class taskClass)
public void addTarget(Target target)
target
- is the Target to be added to the current
Project.public void addTarget(java.lang.String targetName, Target target) throws BuildException
target
- is the Target to be added to the current
Project.targetName
- is the name to use for the Targetpublic void addOrReplaceTarget(Target target)
target
- is the Target to be added or replaced in
the current Project.public void addOrReplaceTarget(java.lang.String targetName, Target target)
target
- is the Target to be added/replaced in
the current Project.targetName
- is the name to use for the Targetpublic java.util.Hashtable getTargets()
public Task createTask(java.lang.String taskType) throws BuildException
public void executeTargets(java.util.Vector targetNames) throws BuildException
public void executeTarget(java.lang.String targetName) throws BuildException
public java.io.File resolveFile(java.lang.String fileName)
public java.lang.String translatePath(java.lang.String to_process)
All it does is translate the : into ; and / into \ if needed. In other words, it isn't perfect.
public void copyFile(java.lang.String sourceFile, java.lang.String destFile) throws java.io.IOException
public void copyFile(java.lang.String sourceFile, java.lang.String destFile, boolean filtering) throws java.io.IOException
public void copyFile(java.io.File sourceFile, java.io.File destFile) throws java.io.IOException
public void copyFile(java.io.File sourceFile, java.io.File destFile, boolean filtering) throws java.io.IOException
public static boolean toBoolean(java.lang.String s)
public void addReference(java.lang.String name, java.lang.Object value)
public java.util.Hashtable getReferences()
protected void fireBuildStarted()
protected void fireBuildFinished(java.lang.Throwable exception)
protected void fireTargetStarted()
protected void fireTargetFinished(java.lang.Throwable exception)
protected void fireTaskStarted()
protected void fireTaskFinished(java.lang.Throwable exception)
protected void fireMessageLogged(java.lang.String message, int priority)
public BuildEvent createBuildEvent()
public BuildEvent createBuildEvent(java.lang.String msg, int priority)
public BuildEvent createBuildEvent(java.lang.Throwable exception)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |