Class Project
- All Implemented Interfaces:
- ResourceFactory
This class also encapsulates methods which allow files to be referred to using abstract path names which are translated to native system file paths at runtime.
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final StringDeprecated.since 1.5.x.static final StringDeprecated.since 1.5.x.static final StringDeprecated.since 1.5.x.static final StringDeprecated.since 1.5.x.static final StringDeprecated.since 1.5.x.static final intMessage priority of "debug".static final intMessage priority of "error".static final intMessage priority of "information".static final intMessage priority of "verbose".static final intMessage priority of "warning".static final StringDefault filter end token.static final StringDefault filter start token.
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddBuildListener(BuildListener listener) Add a build listener to the list.voidaddDataTypeDefinition(String typeName, Class<?> typeClass) Add a new datatype definition.voidDeprecated.since 1.4.x.voidaddIdReference(String id, Object value) Add an id reference.voidaddOrReplaceTarget(String targetName, Target target) Add a target to the project, or replaces one with the same name.voidaddOrReplaceTarget(Target target) Add a target to the project, or replaces one with the same name.voidaddReference(String referenceName, Object value) Add a reference to the project.voidAdd a new target to the project.voidAdd a new target to the project.voidaddTaskDefinition(String taskName, Class<?> taskClass) Add a new task definition to the project.voidcheckTaskClass(Class<?> taskClass) Check whether or not a class is suitable for serving as Ant task.voidDeprecated.since 1.4.xvoidDeprecated.since 1.4.xvoidDeprecated.since 1.4.xvoidcopyFile(File sourceFile, File destFile, boolean filtering, boolean overwrite, boolean preserveLastModified) Deprecated.since 1.4.xvoidDeprecated.since 1.4.xvoidDeprecated.since 1.4.xvoidDeprecated.since 1.4.xvoidcopyFile(String sourceFile, String destFile, boolean filtering, boolean overwrite, boolean preserveLastModified) Deprecated.since 1.4.xvoidcopyInheritedProperties(Project other) Copy all user properties that have not been set on the command line or a GUI tool from this instance to the Project instance given as the argument.voidcopyUserProperties(Project other) Copy all user properties that have been set on the command line or a GUI tool from this instance to the Project instance given as the argument.createClassLoader(ClassLoader parent, Path path) Factory method to create a class loader for loading classes from a given path.createClassLoader(Path path) Factory method to create a class loader for loading classes from a given path.createDataType(String typeName) Create a new instance of a data type.Create and initialize a subproject.createTask(String taskType) Create a new instance of a task, adding it to a list of created tasks for later invalidation.intdefaultInput(byte[] buffer, int offset, int length) Read data from the default input stream.voiddemuxFlush(String output, boolean isError) Demultiplex flush operations so that each task receives the appropriate messages.intdemuxInput(byte[] buffer, int offset, int length) Demux an input request to the correct task.voiddemuxOutput(String output, boolean isWarning) Demultiplex output so that each task receives the appropriate messages.voidexecuteSortedTargets(Vector<Target> sortedTargets) Execute aVectorof sorted targets.voidexecuteTarget(String targetName) Execute the specified target and any targets it depends on.voidexecuteTargets(Vector<String> names) Execute the specified sequence of targets, and the targets they depend on.voidfireBuildFinished(Throwable exception) Send a "build finished" event to the build listeners for this project.voidSend a "build started" event to the build listeners for this project.protected voidfireMessageLogged(Project project, String message, int priority) Send a "message logged" project level event to the build listeners for this project.protected voidfireMessageLogged(Project project, String message, Throwable throwable, int priority) Send a "message logged" project level event to the build listeners for this project.protected voidfireMessageLogged(Target target, String message, int priority) Send a "message logged" target level event to the build listeners for this project.protected voidfireMessageLogged(Target target, String message, Throwable throwable, int priority) Send a "message logged" target level event to the build listeners for this project.protected voidfireMessageLogged(Task task, String message, int priority) Send a "message logged" task level event to the build listeners for this project.protected voidfireMessageLogged(Task task, String message, Throwable throwable, int priority) Send a "message logged" task level event to the build listeners for this project.voidfireSubBuildFinished(Throwable exception) Send a "subbuild finished" event to the build listeners for this project.voidSend a "subbuild started" event to the build listeners for this project.protected voidfireTargetFinished(Target target, Throwable exception) Send a "target finished" event to the build listeners for this project.protected voidfireTargetStarted(Target target) Send a "target started" event to the build listeners for this project.protected voidfireTaskFinished(Task task, Throwable exception) Send a "task finished" event to the build listeners for this project.protected voidfireTaskStarted(Task task) Send a "task started" event to the build listeners for this project.Return the base directory of the project as a file object.Return a copy of the list of build listeners for the project.Return the current datatype definition map.Return a map of the references in the project (String to Object).Return the map of targets.Return the current task definition map.Return the core classloader to use for this project.Return the current datatype definition hashtable.Get this project's input stream.Return the name of the default target of the project.Return the project description, if one has been set.getElementName(Object element) Return a description of the type of the given element, with special handling for instances of tasks and data types.Get this Project's Executor (setting it if necessary).Deprecated.since 1.4.x Use getGlobalFilterSet().getFilterHash().Return the set of global filters.Return a copy of the inherited property hashtable.Retrieve the current input handler.static StringDeprecated.since 1.5.x.getName()Return the project name, if one has been set.static ProjectgetProject(Object o) Get the Project instance associated with the specified object.Return a copy of the properties table.getProperty(String propertyName) Return the value of a property, if it is set.Returns the names of all known properties.<T> TgetReference(String key) Look up a reference by its key (ID).Return a map of the references in the project (String to Object).getResource(String name) Resolve the file relative to the project's basedir and return it as a FileResource.Return the hashtable of targets.Return the current task definition hashtable.getThreadTask(Thread thread) Get the current task associated with a thread, if any.Return a copy of the user property hashtable.getUserProperty(String propertyName) Return the value of a user property, if it is set.booleanhasReference(String key) Does the project know this reference?voidinheritIDReferences(Project parent) Inherit the id references.voidinit()Initialise the project.voidInitializes the properties.voidinitSubProject(Project subProject) Initialize a subproject.booleanReturn the keep-going mode.voidWrite a message to the log with the default log level of MSG_INFO .voidWrite a project level message to the log with the given log level.voidWrite a project level message to the log with the given log level.voidWrite a target level message to the log with the given log level.voidWrite a target level message to the log with the given log level.voidWrite a task level message to the log with the given log level.voidWrite a task level message to the log with the given log level.voidregisterThreadTask(Thread thread, Task task) Register a task as the current task for a thread.voidremoveBuildListener(BuildListener listener) Remove a build listener from the list.replaceProperties(String value) Replace ${} style constructions in the given value with the string value of the corresponding data types.resolveFile(String fileName) Return the canonical form of a filename.resolveFile(String fileName, File rootDir) Deprecated.since 1.4.xvoidsetBasedir(String baseD) Set the base directory for the project, checking that the given filename exists and is a directory.voidsetBaseDir(File baseDir) Set the base directory for the project, checking that the given file exists and is a directory.voidsetCoreLoader(ClassLoader coreLoader) Set the core classloader for the project.voidsetDefault(String defaultTarget) Set the default target of the project.voidsetDefaultInputStream(InputStream defaultInputStream) Set the default System input stream.voidsetDefaultTarget(String defaultTarget) Deprecated.since 1.5.x.voidsetDescription(String description) Set the project description.voidSet the Executor instance for this Project.voidsetFileLastModified(File file, long time) Deprecated.since 1.4.xvoidsetInheritedProperty(String name, String value) Set a user property, which cannot be overwritten by set/unset property calls.voidsetInputHandler(InputHandler handler) Set the input handler.voidSet theant.java.versionproperty and tests for unsupported JVM versions.voidsetKeepGoingMode(boolean keepGoingMode) Set "keep-going" mode.voidSet the name of the project, also setting the user propertyant.project.name.voidsetNewProperty(String name, String value) Set a property if no value currently exists.final voidSet a reference to this Project on the parameterized object.voidsetProperty(String name, String value) Set a property.voidAdd all system properties which aren't already defined as user properties to the project properties.voidsetUserProperty(String name, String value) Set a user property, which cannot be overwritten by set/unset property calls.static booleanReturn the boolean equivalent of a string, which is consideredtrueif either"on","true", or"yes"is found, ignoring case.Topologically sort a set of targets.Topologically sort a set of targets.Topologically sort a set of targets.static StringtranslatePath(String toProcess) Deprecated.since 1.7 Use FileUtils.translatePath instead.
- 
Field Details- 
MSG_ERRpublic static final int MSG_ERRMessage priority of "error".- See Also:
 
- 
MSG_WARNpublic static final int MSG_WARNMessage priority of "warning".- See Also:
 
- 
MSG_INFOpublic static final int MSG_INFOMessage priority of "information".- See Also:
 
- 
MSG_VERBOSEpublic static final int MSG_VERBOSEMessage priority of "verbose".- See Also:
 
- 
MSG_DEBUGpublic static final int MSG_DEBUGMessage priority of "debug".- See Also:
 
- 
JAVA_1_0Deprecated.since 1.5.x. UseJavaEnvUtils.JAVA_1_0instead.Version constant for Java 1.0 .- See Also:
 
- 
JAVA_1_1Deprecated.since 1.5.x. UseJavaEnvUtils.JAVA_1_1instead.Version constant for Java 1.1 .- See Also:
 
- 
JAVA_1_2Deprecated.since 1.5.x. UseJavaEnvUtils.JAVA_1_2instead.Version constant for Java 1.2 .- See Also:
 
- 
JAVA_1_3Deprecated.since 1.5.x. UseJavaEnvUtils.JAVA_1_3instead.Version constant for Java 1.3 .- See Also:
 
- 
JAVA_1_4Deprecated.since 1.5.x. UseJavaEnvUtils.JAVA_1_4instead.Version constant for Java 1.4 .- See Also:
 
- 
TOKEN_STARTDefault filter start token.- See Also:
 
- 
TOKEN_ENDDefault filter end token.- See Also:
 
 
- 
- 
Constructor Details- 
Projectpublic Project()Create a new Ant project.
 
- 
- 
Method Details- 
setInputHandlerSet the input handler.- Parameters:
- handler- the InputHandler instance to use for gathering input.
 
- 
setDefaultInputStreamSet the default System input stream. Normally this stream is set to System.in. This inputStream is used when no task input redirection is being performed.- Parameters:
- defaultInputStream- the default input stream to use when input is requested.
- Since:
- Ant 1.6
 
- 
getDefaultInputStreamGet this project's input stream.- Returns:
- the InputStream instance in use by this Project instance to read input.
 
- 
getInputHandlerRetrieve the current input handler.- Returns:
- the InputHandler instance currently in place for the project instance.
 
- 
createSubProjectCreate and initialize a subproject. By default the subproject will be of the same type as its parent. If a no-arg constructor is unavailable, theProjectclass will be used.- Returns:
- a Project instance configured as a subproject of this Project.
- Since:
- Ant 1.7
 
- 
initSubProjectInitialize a subproject.- Parameters:
- subProject- the subproject to initialize.
 
- 
initInitialise the project. This involves setting the default task definitions and loading the system properties.- Throws:
- BuildException- if the default task list cannot be loaded.
 
- 
initPropertiesInitializes the properties.- Throws:
- BuildException- if an vital property could not be set.
- Since:
- Ant 1.7
 
- 
createClassLoaderFactory method to create a class loader for loading classes from a given path.- Parameters:
- path- the path from which classes are to be loaded.
- Returns:
- an appropriate classloader.
 
- 
createClassLoaderFactory method to create a class loader for loading classes from a given path.- Parameters:
- parent- the parent classloader for the new loader.
- path- the path from which classes are to be loaded.
- Returns:
- an appropriate classloader.
 
- 
setCoreLoaderSet the core classloader for the project. If anullclassloader is specified, the parent classloader should be used.- Parameters:
- coreLoader- The classloader to use for the project. May be- null.
 
- 
getCoreLoaderReturn the core classloader to use for this project. This may benull, indicating that the parent classloader should be used.- Returns:
- the core classloader to use for this project.
 
- 
addBuildListenerAdd a build listener to the list. This listener will be notified of build events for this project.- Parameters:
- listener- The listener to add to the list. Must not be- null.
 
- 
removeBuildListenerRemove a build listener from the list. This listener will no longer be notified of build events for this project.- Parameters:
- listener- The listener to remove from the list. Should not be- null.
 
- 
getBuildListenersReturn a copy of the list of build listeners for the project.- Returns:
- a list of build listeners for the project
 
- 
logWrite a message to the log with the default log level of MSG_INFO .- Parameters:
- message- The text to log. Should not be- null.
 
- 
logWrite a project level message to the log with the given log level.- Parameters:
- message- The text to log. Should not be- null.
- msgLevel- The log priority level to use.
 
- 
logWrite a project level message to the log with the given log level.- Parameters:
- message- The text to log. Should not be- null.
- throwable- The exception causing this log, may be- null.
- msgLevel- The log priority level to use.
- Since:
- 1.7
 
- 
logWrite a task level message to the log with the given log level.- Parameters:
- task- The task to use in the log. Must not be- null.
- message- The text to log. Should not be- null.
- msgLevel- The log priority level to use.
 
- 
logWrite a task level message to the log with the given log level.- Parameters:
- task- The task to use in the log. Must not be- null.
- message- The text to log. Should not be- null.
- throwable- The exception causing this log, may be- null.
- msgLevel- The log priority level to use.
- Since:
- 1.7
 
- 
logWrite a target level message to the log with the given log level.- Parameters:
- target- The target to use in the log. Must not be- null.
- message- The text to log. Should not be- null.
- msgLevel- The log priority level to use.
 
- 
logWrite a target level message to the log with the given log level.- Parameters:
- target- The target to use in the log. Must not be- null.
- message- The text to log. Should not be- null.
- throwable- The exception causing this log, may be- null.
- msgLevel- The log priority level to use.
- Since:
- 1.7
 
- 
getGlobalFilterSetReturn the set of global filters.- Returns:
- the set of global filters.
 
- 
setPropertySet a property. Any existing property of the same name is overwritten, unless it is a user property.- Parameters:
- name- The name of property to set. Must not be- null.
- value- The new value of the property. Must not be- null.
 
- 
setNewPropertySet a property if no value currently exists. If the property exists already, a message is logged and the method returns with no other effect.- Parameters:
- name- The name of property to set. Must not be- null.
- value- The new value of the property. Must not be- null.
- Since:
- 1.5
 
- 
setUserPropertySet a user property, which cannot be overwritten by set/unset property calls. Any previous value is overwritten.- Parameters:
- name- The name of property to set. Must not be- null.
- value- The new value of the property. Must not be- null.
- See Also:
 
- 
setInheritedPropertySet a user property, which cannot be overwritten by set/unset property calls. Any previous value is overwritten. Also marks these properties as properties that have not come from the command line.- Parameters:
- name- The name of property to set. Must not be- null.
- value- The new value of the property. Must not be- null.
- See Also:
 
- 
getPropertyReturn the value of a property, if it is set.- Parameters:
- propertyName- The name of the property. May be- null, in which case the return value is also- null.
- Returns:
- the property value, or nullfor no match or if anullname is provided.
 
- 
replacePropertiesReplace ${} style constructions in the given value with the string value of the corresponding data types.- Parameters:
- value- The string to be scanned for property references. May be- null.
- Returns:
- the given string with embedded property names replaced
         by values, or nullif the given string isnull.
- Throws:
- BuildException- if the given value has an unclosed property name, e.g.- ${xxx.
 
- 
getUserPropertyReturn the value of a user property, if it is set.- Parameters:
- propertyName- The name of the property. May be- null, in which case the return value is also- null.
- Returns:
- the property value, or nullfor no match or if anullname is provided.
 
- 
getPropertiesReturn a copy of the properties table.- Returns:
- a hashtable containing all properties (including user properties) known to the project directly, does not contain local properties.
 
- 
getPropertyNamesReturns the names of all known properties.- Returns:
- the names of all known properties including local user and local properties.
- Since:
- 1.10.9
 
- 
getUserPropertiesReturn a copy of the user property hashtable.- Returns:
- a hashtable containing just the user properties.
 
- 
getInheritedPropertiesReturn a copy of the inherited property hashtable.- Returns:
- a hashtable containing just the inherited properties.
- Since:
- Ant 1.8.0
 
- 
copyUserPropertiesCopy all user properties that have been set on the command line or a GUI tool from this instance to the Project instance given as the argument.To copy all "user" properties, you will also have to call copyInheritedProperties.- Parameters:
- other- the project to copy the properties to. Must not be null.
- Since:
- Ant 1.5
 
- 
copyInheritedPropertiesCopy all user properties that have not been set on the command line or a GUI tool from this instance to the Project instance given as the argument.To copy all "user" properties, you will also have to call copyUserProperties.- Parameters:
- other- the project to copy the properties to. Must not be null.
- Since:
- Ant 1.5
 
- 
setDefaultTargetDeprecated.since 1.5.x. Use setDefault.Set the default target of the project.- Parameters:
- defaultTarget- The name of the default target for this project. May be- null, indicating that there is no default target.
- See Also:
 
- 
getDefaultTargetReturn the name of the default target of the project.- Returns:
- name of the default target or
         nullif no default has been set.
 
- 
setDefaultSet the default target of the project.- Parameters:
- defaultTarget- The name of the default target for this project. May be- null, indicating that there is no default target.
 
- 
setNameSet the name of the project, also setting the user propertyant.project.name.- Parameters:
- name- The name of the project. Must not be- null.
 
- 
getNameReturn the project name, if one has been set.- Returns:
- the project name, or nullif it hasn't been set.
 
- 
setDescriptionSet the project description.- Parameters:
- description- The description of the project. May be- null.
 
- 
getDescriptionReturn the project description, if one has been set.- Returns:
- the project description, or nullif it hasn't been set.
 
- 
addFilterDeprecated.since 1.4.x. Use getGlobalFilterSet().addFilter(token,value)Add a filter to the set of global filters.- Parameters:
- token- The token to filter. Must not be- null.
- value- The replacement value. Must not be- null.
- See Also:
 
- 
getFiltersDeprecated.since 1.4.x Use getGlobalFilterSet().getFilterHash().Return a hashtable of global filters, mapping tokens to values.- Returns:
- a hashtable of global filters, mapping tokens to values (String to String).
- See Also:
 
- 
setBasedirSet the base directory for the project, checking that the given filename exists and is a directory.- Parameters:
- baseD- The project base directory. Must not be- null.
- Throws:
- BuildException- if the directory if invalid.
 
- 
setBaseDirSet the base directory for the project, checking that the given file exists and is a directory.- Parameters:
- baseDir- The project base directory. Must not be- null.
- Throws:
- BuildException- if the specified file doesn't exist or isn't a directory.
 
- 
getBaseDirReturn the base directory of the project as a file object.- Returns:
- the project base directory, or nullif the base directory has not been successfully set to a valid value.
 
- 
setKeepGoingModepublic void setKeepGoingMode(boolean keepGoingMode) Set "keep-going" mode. In this mode Ant will try to execute as many targets as possible. All targets that do not depend on failed target(s) will be executed. If the keepGoing setter/getter methods are used in conjunction with theant.executor.classproperty, they will have no effect.- Parameters:
- keepGoingMode- "keep-going" mode
- Since:
- Ant 1.6
 
- 
isKeepGoingModepublic boolean isKeepGoingMode()Return the keep-going mode. If the keepGoing setter/getter methods are used in conjunction with theant.executor.classproperty, they will have no effect.- Returns:
- "keep-going" mode
- Since:
- Ant 1.6
 
- 
getJavaVersionDeprecated.since 1.5.x. Use org.apache.tools.ant.util.JavaEnvUtils instead.Return the version of Java this class is running under.- Returns:
- the version of Java as a String, e.g. "1.1" .
- See Also:
 
- 
setJavaVersionPropertySet theant.java.versionproperty and tests for unsupported JVM versions. If the version is supported, verbose log messages are generated to record the Java version and operating system name.- Throws:
- BuildException- if this Java version is not supported.
- See Also:
 
- 
setSystemPropertiespublic void setSystemProperties()Add all system properties which aren't already defined as user properties to the project properties.
- 
addTaskDefinitionAdd a new task definition to the project. Attempting to override an existing definition with an equivalent one (i.e. with the same classname) results in a verbose log message. Attempting to override an existing definition with a different one results in a warning log message and invalidates any tasks which have already been created with the old definition.- Parameters:
- taskName- The name of the task to add. Must not be- null.
- taskClass- The full name of the class implementing the task. Must not be- null.
- Throws:
- BuildException- if the class is unsuitable for being an Ant task. An error level message is logged before this exception is thrown.
- See Also:
 
- 
checkTaskClassCheck whether or not a class is suitable for serving as Ant task. Ant task implementation classes must be public, concrete, and have a no-arg constructor.- Parameters:
- taskClass- The class to be checked. Must not be- null.
- Throws:
- BuildException- if the class is unsuitable for being an Ant task. An error level message is logged before this exception is thrown.
 
- 
getTaskDefinitionsReturn the current task definition hashtable. The returned hashtable is "live" and so should not be modified.- Returns:
- a map of from task name to implementing class (String to Class).
 
- 
getCopyOfTaskDefinitionsReturn the current task definition map. The returned map is a copy of the "live" definitions.- Returns:
- a map of from task name to implementing class (String to Class).
- Since:
- Ant 1.8.1
 
- 
addDataTypeDefinitionAdd a new datatype definition. Attempting to override an existing definition with an equivalent one (i.e. with the same classname) results in a verbose log message. Attempting to override an existing definition with a different one results in a warning log message, but the definition is changed.- Parameters:
- typeName- The name of the datatype. Must not be- null.
- typeClass- The full name of the class implementing the datatype. Must not be- null.
 
- 
getDataTypeDefinitionsReturn the current datatype definition hashtable. The returned hashtable is "live" and so should not be modified.- Returns:
- a map of from datatype name to implementing class (String to Class).
 
- 
getCopyOfDataTypeDefinitionsReturn the current datatype definition map. The returned map is a copy pf the "live" definitions.- Returns:
- a map of from datatype name to implementing class (String to Class).
- Since:
- Ant 1.8.1
 
- 
addTargetAdd a new target to the project.- Parameters:
- target- The target to be added to the project. Must not be- null.
- Throws:
- BuildException- if the target already exists in the project
- See Also:
 
- 
addTargetAdd a new target to the project.- Parameters:
- targetName- The name to use for the target. Must not be- null.
- target- The target to be added to the project. Must not be- null.
- Throws:
- BuildException- if the target already exists in the project.
- See Also:
 
- 
addOrReplaceTargetAdd a target to the project, or replaces one with the same name.- Parameters:
- target- The target to be added or replaced in the project. Must not be- null.
 
- 
addOrReplaceTargetAdd a target to the project, or replaces one with the same name.- Parameters:
- targetName- The name to use for the target. Must not be- null.
- target- The target to be added or replaced in the project. Must not be- null.
 
- 
getTargetsReturn the hashtable of targets. The returned hashtable is "live" and so should not be modified.- Returns:
- a map from name to target (String to Target).
 
- 
getCopyOfTargetsReturn the map of targets. The returned map is a copy of the "live" targets.- Returns:
- a map from name to target (String to Target).
- Since:
- Ant 1.8.1
 
- 
createTaskCreate a new instance of a task, adding it to a list of created tasks for later invalidation. This causes all tasks to be remembered until the containing project is removed- Parameters:
- taskType- The name of the task to create an instance of. Must not be- null.
- Returns:
- an instance of the specified task, or nullif the task name is not recognised.
- Throws:
- BuildException- if the task name is recognised but task creation fails.
 
- 
createDataTypeCreate a new instance of a data type.- Parameters:
- typeName- The name of the data type to create an instance of. Must not be- null.
- Returns:
- an instance of the specified data type, or nullif the data type name is not recognised.
- Throws:
- BuildException- if the data type name is recognised but instance creation fails.
 
- 
setExecutorSet the Executor instance for this Project.- Parameters:
- e- the Executor to use.
 
- 
getExecutorGet this Project's Executor (setting it if necessary).- Returns:
- an Executor instance.
 
- 
executeTargetsExecute the specified sequence of targets, and the targets they depend on.- Parameters:
- names- A vector of target name strings to execute. Must not be- null.
- Throws:
- BuildException- if the build failed.
 
- 
demuxOutputDemultiplex output so that each task receives the appropriate messages. If the current thread is not currently executing a task, the message is logged directly.- Parameters:
- output- Message to handle. Should not be- null.
- isWarning- Whether the text represents an warning (- true) or information (- false).
 
- 
defaultInputRead data from the default input stream. If no default has been specified, System.in is used.- Parameters:
- buffer- the buffer into which data is to be read.
- offset- the offset into the buffer at which data is stored.
- length- the amount of data to read.
- Returns:
- the number of bytes read.
- Throws:
- IOException- if the data cannot be read.
- Since:
- Ant 1.6
 
- 
demuxInputDemux an input request to the correct task.- Parameters:
- buffer- the buffer into which data is to be read.
- offset- the offset into the buffer at which data is stored.
- length- the amount of data to read.
- Returns:
- the number of bytes read.
- Throws:
- IOException- if the data cannot be read.
- Since:
- Ant 1.6
 
- 
demuxFlushDemultiplex flush operations so that each task receives the appropriate messages. If the current thread is not currently executing a task, the message is logged directly.- Parameters:
- output- Message to handle. Should not be- null.
- isError- Whether the text represents an error (- true) or information (- false).
- Since:
- Ant 1.5.2
 
- 
executeTargetExecute the specified target and any targets it depends on.- Parameters:
- targetName- The name of the target to execute. Must not be- null.
- Throws:
- BuildException- if the build failed.
 
- 
executeSortedTargetsExecute aVectorof sorted targets.- Parameters:
- sortedTargets- the aforementioned- Vector.
- Throws:
- BuildException- on error.
 
- 
resolveFileDeprecated.since 1.4.xReturn the canonical form of a filename.If the specified file name is relative it is resolved with respect to the given root directory. - Parameters:
- fileName- The name of the file to resolve. Must not be- null.
- rootDir- The directory respective to which relative file names are resolved. May be- null, in which case the current directory is used.
- Returns:
- the resolved File.
 
- 
resolveFileReturn the canonical form of a filename.If the specified file name is relative it is resolved with respect to the project's base directory. - Parameters:
- fileName- The name of the file to resolve. Must not be- null.
- Returns:
- the resolved File.
 
- 
translatePathDeprecated.since 1.7 Use FileUtils.translatePath instead.Translate a path into its native (platform specific) format.This method uses PathTokenizer to separate the input path into its components. This handles DOS style paths in a relatively sensible way. The file separators are then converted to their platform specific versions. - Parameters:
- toProcess- The path to be translated. May be- null.
- Returns:
- the native version of the specified path or
         an empty string if the path is nullor empty.
- See Also:
 
- 
copyFileDeprecated.since 1.4.xConvenience method to copy a file from a source to a destination. No filtering is performed.- Parameters:
- sourceFile- Name of file to copy from. Must not be- null.
- destFile- Name of file to copy to. Must not be- null.
- Throws:
- IOException- if the copying fails.
 
- 
copyFile@Deprecated public void copyFile(String sourceFile, String destFile, boolean filtering) throws IOException Deprecated.since 1.4.xConvenience method to copy a file from a source to a destination specifying if token filtering should be used.- Parameters:
- sourceFile- Name of file to copy from. Must not be- null.
- destFile- Name of file to copy to. Must not be- null.
- filtering- Whether or not token filtering should be used during the copy.
- Throws:
- IOException- if the copying fails.
 
- 
copyFile@Deprecated public void copyFile(String sourceFile, String destFile, boolean filtering, boolean overwrite) throws IOException Deprecated.since 1.4.xConvenience method to copy a file from a source to a destination specifying if token filtering should be used and if source files may overwrite newer destination files.- Parameters:
- sourceFile- Name of file to copy from. Must not be- null.
- destFile- Name of file to copy to. Must not be- null.
- filtering- Whether or not token filtering should be used during the copy.
- overwrite- Whether or not the destination file should be overwritten if it already exists.
- Throws:
- IOException- if the copying fails.
 
- 
copyFile@Deprecated public void copyFile(String sourceFile, String destFile, boolean filtering, boolean overwrite, boolean preserveLastModified) throws IOException Deprecated.since 1.4.xConvenience method to copy a file from a source to a destination specifying if token filtering should be used, if source files may overwrite newer destination files, and if the last modified time of the resulting file should be set to that of the source file.- Parameters:
- sourceFile- Name of file to copy from. Must not be- null.
- destFile- Name of file to copy to. Must not be- null.
- filtering- Whether or not token filtering should be used during the copy.
- overwrite- Whether or not the destination file should be overwritten if it already exists.
- preserveLastModified- Whether or not the last modified time of the resulting file should be set to that of the source file.
- Throws:
- IOException- if the copying fails.
 
- 
copyFileDeprecated.since 1.4.xConvenience method to copy a file from a source to a destination. No filtering is performed.- Parameters:
- sourceFile- File to copy from. Must not be- null.
- destFile- File to copy to. Must not be- null.
- Throws:
- IOException- if the copying fails.
 
- 
copyFile@Deprecated public void copyFile(File sourceFile, File destFile, boolean filtering) throws IOException Deprecated.since 1.4.xConvenience method to copy a file from a source to a destination specifying if token filtering should be used.- Parameters:
- sourceFile- File to copy from. Must not be- null.
- destFile- File to copy to. Must not be- null.
- filtering- Whether or not token filtering should be used during the copy.
- Throws:
- IOException- if the copying fails.
 
- 
copyFile@Deprecated public void copyFile(File sourceFile, File destFile, boolean filtering, boolean overwrite) throws IOException Deprecated.since 1.4.xConvenience method to copy a file from a source to a destination specifying if token filtering should be used and if source files may overwrite newer destination files.- Parameters:
- sourceFile- File to copy from. Must not be- null.
- destFile- File to copy to. Must not be- null.
- filtering- Whether or not token filtering should be used during the copy.
- overwrite- Whether or not the destination file should be overwritten if it already exists.
- Throws:
- IOException- if the file cannot be copied.
 
- 
copyFile@Deprecated public void copyFile(File sourceFile, File destFile, boolean filtering, boolean overwrite, boolean preserveLastModified) throws IOException Deprecated.since 1.4.xConvenience method to copy a file from a source to a destination specifying if token filtering should be used, if source files may overwrite newer destination files, and if the last modified time of the resulting file should be set to that of the source file.- Parameters:
- sourceFile- File to copy from. Must not be- null.
- destFile- File to copy to. Must not be- null.
- filtering- Whether or not token filtering should be used during the copy.
- overwrite- Whether or not the destination file should be overwritten if it already exists.
- preserveLastModified- Whether or not the last modified time of the resulting file should be set to that of the source file.
- Throws:
- IOException- if the file cannot be copied.
 
- 
setFileLastModifiedDeprecated.since 1.4.xCall File.setLastModified(long time) on Java above 1.1, and logs a warning on Java 1.1.- Parameters:
- file- The file to set the last modified time on. Must not be- null.
- time- the required modification time.
- Throws:
- BuildException- if the last modified time cannot be set despite running on a platform with a version above 1.1.
 
- 
toBooleanReturn the boolean equivalent of a string, which is consideredtrueif either"on","true", or"yes"is found, ignoring case.- Parameters:
- s- The string to convert to a boolean value.
- Returns:
- trueif the given string is- "on",- "true"or- "yes", or- falseotherwise.
 
- 
getProjectGet the Project instance associated with the specified object.- Parameters:
- o- the object to query.
- Returns:
- Project instance, if any.
- Since:
- Ant 1.7.1
 
- 
topoSortpublic final Vector<Target> topoSort(String root, Hashtable<String, Target> targetTable) throws BuildExceptionTopologically sort a set of targets. Equivalent to callingtopoSort(new String[] {root}, targets, true).- Parameters:
- root- The name of the root target. The sort is created in such a way that the sequence of Targets up to the root target is the minimum possible such sequence. Must not be- null.
- targetTable- A Hashtable mapping names to Targets. Must not be- null.
- Returns:
- a Vector of ALL Target objects in sorted order.
- Throws:
- BuildException- if there is a cyclic dependency among the targets, or if a named target does not exist.
 
- 
topoSortpublic final Vector<Target> topoSort(String root, Hashtable<String, Target> targetTable, boolean returnAll) throws BuildExceptionTopologically sort a set of targets. Equivalent to callingtopoSort(new String[] {root}, targets, returnAll).- Parameters:
- root- The name of the root target. The sort is created in such a way that the sequence of Targets up to the root target is the minimum possible such sequence. Must not be- null.
- targetTable- A Hashtable mapping names to Targets. Must not be- null.
- returnAll-- booleanindicating whether to return all targets, or the execution sequence only.
- Returns:
- a Vector of Target objects in sorted order.
- Throws:
- BuildException- if there is a cyclic dependency among the targets, or if a named target does not exist.
- Since:
- Ant 1.6.3
 
- 
topoSortpublic final Vector<Target> topoSort(String[] roots, Hashtable<String, Target> targetTable, boolean returnAll) throws BuildExceptionTopologically sort a set of targets.- Parameters:
- roots-- String[]containing the names of the root targets. The sort is created in such a way that the ordered sequence of Targets is the minimum possible such sequence to the specified root targets. Must not be- null.
- targetTable- A map of names to targets (String to Target). Must not be- null.
- returnAll-- booleanindicating whether to return all targets, or the execution sequence only.
- Returns:
- a Vector of Target objects in sorted order.
- Throws:
- BuildException- if there is a cyclic dependency among the targets, or if a named target does not exist.
- Since:
- Ant 1.6.3
 
- 
inheritIDReferencesInherit the id references.- Parameters:
- parent- the parent project of this project.
 
- 
addIdReferenceAdd an id reference. Used for broken build files.- Parameters:
- id- the id to set.
- value- the value to set it to (Unknown element in this case.
 
- 
addReferenceAdd a reference to the project.- Parameters:
- referenceName- The name of the reference. Must not be- null.
- value- The value of the reference.
 
- 
getReferencesReturn a map of the references in the project (String to Object). The returned hashtable is "live" and so must not be modified.- Returns:
- a map of the references in the project (String to Object).
 
- 
hasReferenceDoes the project know this reference?- Parameters:
- key- String
- Returns:
- boolean
- Since:
- Ant 1.8.0
 
- 
getCopyOfReferencesReturn a map of the references in the project (String to Object). The returned hashtable is a copy of the "live" references.- Returns:
- a map of the references in the project (String to Object).
- Since:
- Ant 1.8.1
 
- 
getReferenceLook up a reference by its key (ID).- Type Parameters:
- T- desired type
- Parameters:
- key- The key for the desired reference. Must not be- null.
- Returns:
- the reference with the specified ID, or nullif there is no such reference in the project, with type inference.
 
- 
getElementNameReturn a description of the type of the given element, with special handling for instances of tasks and data types.This is useful for logging purposes. - Parameters:
- element- The element to describe. Must not be- null.
- Returns:
- a description of the element type.
- Since:
- 1.95, Ant 1.5
 
- 
fireBuildStartedpublic void fireBuildStarted()Send a "build started" event to the build listeners for this project.
- 
fireBuildFinishedSend a "build finished" event to the build listeners for this project.- Parameters:
- exception- an exception indicating a reason for a build failure. May be- null, indicating a successful build.
 
- 
fireSubBuildStartedpublic void fireSubBuildStarted()Send a "subbuild started" event to the build listeners for this project.- Since:
- Ant 1.6.2
 
- 
fireSubBuildFinishedSend a "subbuild finished" event to the build listeners for this project.- Parameters:
- exception- an exception indicating a reason for a build failure. May be- null, indicating a successful build.
- Since:
- Ant 1.6.2
 
- 
fireTargetStartedSend a "target started" event to the build listeners for this project.- Parameters:
- target- The target which is starting to build. Must not be- null.
 
- 
fireTargetFinishedSend a "target finished" event to the build listeners for this project.- Parameters:
- target- The target which has finished building. Must not be- null.
- exception- an exception indicating a reason for a build failure. May be- null, indicating a successful build.
 
- 
fireTaskStartedSend a "task started" event to the build listeners for this project.- Parameters:
- task- The target which is starting to execute. Must not be- null.
 
- 
fireTaskFinishedSend a "task finished" event to the build listeners for this project.- Parameters:
- task- The task which has finished executing. Must not be- null.
- exception- an exception indicating a reason for a build failure. May be- null, indicating a successful build.
 
- 
fireMessageLoggedSend a "message logged" project level event to the build listeners for this project.- Parameters:
- project- The project generating the event. Should not be- null.
- message- The message to send. Should not be- null.
- priority- The priority of the message.
 
- 
fireMessageLoggedprotected void fireMessageLogged(Project project, String message, Throwable throwable, int priority) Send a "message logged" project level event to the build listeners for this project.- Parameters:
- project- The project generating the event. Should not be- null.
- message- The message to send. Should not be- null.
- throwable- The exception that caused this message. May be- null.
- priority- The priority of the message.
- Since:
- 1.7
 
- 
fireMessageLoggedSend a "message logged" target level event to the build listeners for this project.- Parameters:
- target- The target generating the event. Must not be- null.
- message- The message to send. Should not be- null.
- priority- The priority of the message.
 
- 
fireMessageLoggedSend a "message logged" target level event to the build listeners for this project.- Parameters:
- target- The target generating the event. Must not be- null.
- message- The message to send. Should not be- null.
- throwable- The exception that caused this message. May be- null.
- priority- The priority of the message.
- Since:
- 1.7
 
- 
fireMessageLoggedSend a "message logged" task level event to the build listeners for this project.- Parameters:
- task- The task generating the event. Must not be- null.
- message- The message to send. Should not be- null.
- priority- The priority of the message.
 
- 
fireMessageLoggedSend a "message logged" task level event to the build listeners for this project.- Parameters:
- task- The task generating the event. Must not be- null.
- message- The message to send. Should not be- null.
- throwable- The exception that caused this message. May be- null.
- priority- The priority of the message.
- Since:
- 1.7
 
- 
registerThreadTaskRegister a task as the current task for a thread. If the task is null, the thread's entry is removed.- Parameters:
- thread- the thread on which the task is registered.
- task- the task to be registered.
- Since:
- Ant 1.5
 
- 
getThreadTaskGet the current task associated with a thread, if any.- Parameters:
- thread- the thread for which the task is required.
- Returns:
- the task which is currently registered for the given thread or null if no task is registered.
 
- 
setProjectReferenceSet a reference to this Project on the parameterized object. Need to set the project before other set/add elements are called.- Parameters:
- obj- the object to invoke setProject(this) on.
 
- 
getResourceResolve the file relative to the project's basedir and return it as a FileResource.- Specified by:
- getResourcein interface- ResourceFactory
- Parameters:
- name- the name of the file to resolve.
- Returns:
- the file resource.
- Since:
- Ant 1.7
 
 
-