Index B - Apache Ant API

B

backslash(String) - Static method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Change

Ensure that a string is backslashing slashes so that it does not confuse them with Perl substitution delimiter in Oro.

BAS_DD - Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool

 

Base64Converter - Class in org.apache.tools.ant.util

BASE 64 encoding of a String or an array of bytes.

Base64Converter() - Constructor for class org.apache.tools.ant.util.Base64Converter

 

baseBlockSize - Static variable in interface org.apache.tools.bzip2.BZip2Constants

 

basedir - Variable in class org.apache.tools.ant.DirectoryScanner

The base directory to be scanned.

BaseExtendSelector - Class in org.apache.tools.ant.types.selectors

Convenience base class for all selectors accessed through ExtendSelector.

BaseExtendSelector() - Constructor for class org.apache.tools.ant.types.selectors.BaseExtendSelector

Default constructor.

BaseFilterReader - Class in org.apache.tools.ant.filters

Base class for core filter readers.

BaseFilterReader() - Constructor for class org.apache.tools.ant.filters.BaseFilterReader

Constructor used by Ant's introspection mechanism.

BaseFilterReader(Reader) - Constructor for class org.apache.tools.ant.filters.BaseFilterReader

Creates a new filtered reader.

BASEJARNAME - Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.NamingScheme

Naming scheme where the generated jar is named by the basejarname attribute

Basename - Class in org.apache.tools.ant.taskdefs

Sets a property to the base name of a specified file, optionally minus a suffix.

Basename() - Constructor for class org.apache.tools.ant.taskdefs.Basename

 

BaseParamFilterReader - Class in org.apache.tools.ant.filters

Parameterized base class for core filter readers.

BaseParamFilterReader() - Constructor for class org.apache.tools.ant.filters.BaseParamFilterReader

Constructor for "dummy" instances.

BaseParamFilterReader(Reader) - Constructor for class org.apache.tools.ant.filters.BaseParamFilterReader

Creates a new filtered reader.

BaseResourceCollectionContainer - Class in org.apache.tools.ant.types.resources

Base class for ResourceCollections that nest multiple ResourceCollections.

BaseResourceCollectionContainer() - Constructor for class org.apache.tools.ant.types.resources.BaseResourceCollectionContainer

Create a new BaseResourceCollectionContainer.

BaseResourceCollectionContainer(Project) - Constructor for class org.apache.tools.ant.types.resources.BaseResourceCollectionContainer

Create a new BaseResourceCollectionContainer.

BaseResourceCollectionWrapper - Class in org.apache.tools.ant.types.resources

Base class for a ResourceCollection that wraps a single nested ResourceCollection.

BaseResourceCollectionWrapper() - Constructor for class org.apache.tools.ant.types.resources.BaseResourceCollectionWrapper

 

BaseSelector - Class in org.apache.tools.ant.types.selectors

A convenience base class that you can subclass Selectors from.

BaseSelector() - Constructor for class org.apache.tools.ant.types.selectors.BaseSelector

Do nothing constructor.

BaseSelectorContainer - Class in org.apache.tools.ant.types.selectors

This is the base class for selectors that can contain other selectors.

BaseSelectorContainer() - Constructor for class org.apache.tools.ant.types.selectors.BaseSelectorContainer

Default constructor.

BaseTest - Class in org.apache.tools.ant.taskdefs.optional.junit

Baseclass for BatchTest and JUnitTest.

BaseTest() - Constructor for class org.apache.tools.ant.taskdefs.optional.junit.BaseTest

 

BasicShape - Class in org.apache.tools.ant.types.optional.image

Draw a basic shape

BasicShape() - Constructor for class org.apache.tools.ant.types.optional.image.BasicShape

 

BatchTest - Class in org.apache.tools.ant.taskdefs.optional.junit

Create then run JUnitTest's based on the list of files given by the fileset attribute.

BatchTest(Project) - Constructor for class org.apache.tools.ant.taskdefs.optional.junit.BatchTest

create a new batchtest instance

bcc(String) - Method in class org.apache.tools.mail.MailMessage

Sets the bcc address.

bccList - Variable in class org.apache.tools.ant.taskdefs.email.Mailer

 

BCFileSet - Class in org.apache.tools.ant.types.resources

Utility FileSet that includes directories for backwards-compatibility with certain tasks e.g.

BCFileSet() - Constructor for class org.apache.tools.ant.types.resources.BCFileSet

Default constructor.

BCFileSet(FileSet) - Constructor for class org.apache.tools.ant.types.resources.BCFileSet

Construct a new BCFileSet from the specified FileSet.

BEFORE - Static variable in class org.apache.tools.ant.types.TimeComparison

Before Comparison.

beginDownload() - Method in interface org.apache.tools.ant.taskdefs.Get.DownloadProgress

begin a download

beginDownload() - Method in class org.apache.tools.ant.taskdefs.Get.NullProgress

begin a download

beginDownload() - Method in class org.apache.tools.ant.taskdefs.Get.VerboseProgress

begin a download

beginExecution() - Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask

init processing logic; this is retained through our execution(s)

BES_DD - Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool

 

BigProjectLogger - Class in org.apache.tools.ant.listener

This is a special logger that is designed to make it easier to work with big projects, those that use imports and subant to build complex systems.

BigProjectLogger() - Constructor for class org.apache.tools.ant.listener.BigProjectLogger

 

BindTargets - Class in org.apache.tools.ant.taskdefs

Simple task which bind some targets to some defined extension point

BindTargets() - Constructor for class org.apache.tools.ant.taskdefs.BindTargets

 

bindToComponent(ProjectComponent) - Method in class org.apache.tools.ant.util.ScriptRunnerBase

Bind the runner to a project component.

bindToComponentMinimum(ProjectComponent) - Method in class org.apache.tools.ant.util.ScriptRunnerBase

Bind the runner to a project component.

bindToKeystore(ExecTask) - Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask

bind to a keystore if the attributes are there

bindToOwner(Task) - Method in class org.apache.tools.ant.Task

Bind a task to another; use this when configuring a newly created task to do work on behalf of another.

BlockFor - Class in org.apache.tools.ant.taskdefs.optional.testing

 

BlockFor() - Constructor for class org.apache.tools.ant.taskdefs.optional.testing.BlockFor

Constructor that takes the name of the task in the task name.

BlockFor(String) - Constructor for class org.apache.tools.ant.taskdefs.optional.testing.BlockFor

Constructor that takes the name of the task in the task name.

bootclasspath - Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter

 

BorlandDeploymentTool - Class in org.apache.tools.ant.taskdefs.optional.ejb

BorlandDeploymentTool is dedicated to the Borland Application Server 4.5 and 4.5.1 This task generates and compiles the stubs and skeletons for all ejb described into the Deployment Descriptor, builds the jar file including the support files and verify whether the produced jar is valid or not.

BorlandDeploymentTool() - Constructor for class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool

 

BorlandGenerateClient - Class in org.apache.tools.ant.taskdefs.optional.ejb

Generates a Borland Application Server 4.5 client JAR using as input the EJB JAR file.

BorlandGenerateClient() - Constructor for class org.apache.tools.ant.taskdefs.optional.ejb.BorlandGenerateClient

 

br - Variable in class org.apache.tools.ant.taskdefs.JikesOutputParser

Deprecated.

 

BRIEF_FORMATTER_CLASS_NAME - Static variable in class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement

brief formatter class

BriefJUnitResultFormatter - Class in org.apache.tools.ant.taskdefs.optional.junit

Prints plain text output of the test to a specified Writer.

BriefJUnitResultFormatter() - Constructor for class org.apache.tools.ant.taskdefs.optional.junit.BriefJUnitResultFormatter

Constructor for BriefJUnitResultFormatter.

buf - Variable in class org.apache.tools.zip.ZipOutputStream

This buffer servers as a Deflater.

buffer - Variable in class org.apache.tools.tar.TarInputStream

 

buffer - Variable in class org.apache.tools.tar.TarOutputStream

 

bufferSize - Variable in class org.apache.tools.ant.filters.util.ChainReaderHelper

The size of the buffer to be used.

BUILD_JAVAC_SOURCE - Static variable in class org.apache.tools.ant.MagicNames

property that provides the default value for javac's and javadoc's source attribute.

BUILD_JAVAC_TARGET - Static variable in class org.apache.tools.ant.MagicNames

property that provides the default value for javac's target attribute.

BUILD_SYSCLASSPATH - Static variable in class org.apache.tools.ant.MagicNames

System classpath policy.

buildArgsPrefix() - Method in class org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool

Builds the prefix arguments to pass to weblogic.deploy.

buildCmdLine() - Method in class org.apache.tools.ant.taskdefs.optional.sos.SOSCheckin

Build the command line.

buildCmdLine() - Method in class org.apache.tools.ant.taskdefs.optional.sos.SOSCheckout

Build the command line
CheckOutFile required parameters: -server -name -password -database -project -file
CheckOutFile optional parameters: -workdir -verbose -nocache -nocompression -soshome
CheckOutProject required parameters: -server -name -password -database -project
CheckOutProject optional parameters:-workdir -recursive -verbose -nocache -nocompression -soshome

buildCmdLine() - Method in class org.apache.tools.ant.taskdefs.optional.sos.SOSGet

Build the command line
GetFile required parameters: -server -name -password -database -project -file
GetFile optional parameters: -workdir -revision -verbose -nocache -nocompression -soshome
GetProject required parameters: -server -name -password -database -project
GetProject optional parameters: -label -workdir -recursive -verbose -nocache -nocompression -soshome

buildCmdLine() - Method in class org.apache.tools.ant.taskdefs.optional.sos.SOSLabel

Build the command line
AddLabel required parameters: -server -name -password -database -project -label
AddLabel optional parameters: -verbose -comment

buildCmdLine() - Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSADD

Builds a command line to execute ss.

buildCmdLine() - Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKIN

Builds a command line to execute ss.

buildCmdLine() - Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKOUT

Builds a command line to execute ss.

buildCmdLine() - Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCP

Builds a command line to execute ss.

buildDeployArgs() - Method in class org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool

Builds the arguments to pass to weblogic.deploy for deployment actions ("deploy" and "update").

BuildEvent - Class in org.apache.tools.ant

Class representing an event occurring during a build.

BuildEvent(Project) - Constructor for class org.apache.tools.ant.BuildEvent

Construct a BuildEvent for a project level event.

BuildEvent(Target) - Constructor for class org.apache.tools.ant.BuildEvent

Construct a BuildEvent for a target level event.

BuildEvent(Task) - Constructor for class org.apache.tools.ant.BuildEvent

Construct a BuildEvent for a task level event.

BuildException - Exception in org.apache.tools.ant

Signals an error condition during a build

BuildException() - Constructor for exception org.apache.tools.ant.BuildException

Constructs a build exception with no descriptive information.

BuildException(String) - Constructor for exception org.apache.tools.ant.BuildException

Constructs an exception with the given descriptive message.

BuildException(String, Throwable) - Constructor for exception org.apache.tools.ant.BuildException

Constructs an exception with the given message and exception as a root cause.

BuildException(String, Throwable, Location) - Constructor for exception org.apache.tools.ant.BuildException

Constructs an exception with the given message and exception as a root cause and a location in a file.

BuildException(Throwable) - Constructor for exception org.apache.tools.ant.BuildException

Constructs an exception with the given exception as a root cause.

BuildException(String, Location) - Constructor for exception org.apache.tools.ant.BuildException

Constructs an exception with the given descriptive message and a location in a file.

BuildException(Throwable, Location) - Constructor for exception org.apache.tools.ant.BuildException

Constructs an exception with the given exception as a root cause and a location in a file.

buildFinished(BuildEvent) - Method in class org.apache.tools.ant.AntClassLoader

Cleans up any resources held by this classloader at the end of a build.

buildFinished(BuildEvent) - Method in interface org.apache.tools.ant.BuildListener

Signals that the last target has finished.

buildFinished(BuildEvent) - Method in class org.apache.tools.ant.DefaultLogger

Prints whether the build succeeded or failed, any errors the occurred during the build, and how long the build took.

buildFinished(BuildEvent) - Method in class org.apache.tools.ant.listener.BigProjectLogger

Prints whether the build succeeded or failed, any errors the occurred during the build, and how long the build took.

buildFinished(BuildEvent) - Method in class org.apache.tools.ant.listener.CommonsLoggingListener

Signals that the last target has finished.

buildFinished(BuildEvent) - Method in class org.apache.tools.ant.listener.Log4jListener

Signals that the last target has finished.

buildFinished(BuildEvent) - Method in class org.apache.tools.ant.listener.MailLogger

Sends an e-mail with the log results.

buildFinished(BuildEvent) - Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder

Not used Signals that the last target has finished.

buildFinished(BuildEvent) - Method in class org.apache.tools.ant.taskdefs.optional.sound.AntSoundPlayer

Fired after the last target has finished.

buildFinished(BuildEvent) - Method in class org.apache.tools.ant.taskdefs.Recorder

Cleans recorder registry.

buildFinished(BuildEvent) - Method in class org.apache.tools.ant.taskdefs.RecorderEntry

Signals that the last target has finished.

buildFinished(BuildEvent) - Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector

Signals that the last target has finished.

buildFinished(BuildEvent) - Method in class org.apache.tools.ant.XmlLogger

Fired when the build finishes, this adds the time taken and any error stacktrace to the build element and writes the document to disk.

buildListArgs() - Method in class org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool

Builds the arguments to pass to weblogic.deploy for the list action

BuildListener - Interface in org.apache.tools.ant

Instances of classes that implement this interface can register to be notified when things happened during a build.

BuildLogger - Interface in org.apache.tools.ant

Interface used by Ant to log the build output.

buildMap(File, File, String[], FileNameMapper, Hashtable) - Method in class org.apache.tools.ant.taskdefs.Copy

Add to a map of files/directories to copy.

buildMap(Resource[], File, FileNameMapper) - Method in class org.apache.tools.ant.taskdefs.Copy

Create a map of resources to copy.

BuildNumber - Class in org.apache.tools.ant.taskdefs

Read, increment, and write a build number in a file It will first attempt to read a build number from a file, then set the property "build.number" to the value that was read in (or 0 if no such value).

BuildNumber() - Constructor for class org.apache.tools.ant.taskdefs.BuildNumber

 

buildStarted(BuildEvent) - Method in class org.apache.tools.ant.AntClassLoader

Empty implementation to satisfy the BuildListener interface.

buildStarted(BuildEvent) - Method in interface org.apache.tools.ant.BuildListener

Signals that a build has started.

buildStarted(BuildEvent) - Method in class org.apache.tools.ant.DefaultLogger

Responds to a build being started by just remembering the current time.

buildStarted(BuildEvent) - Method in class org.apache.tools.ant.listener.CommonsLoggingListener

Signals that a build has started.

buildStarted(BuildEvent) - Method in class org.apache.tools.ant.listener.Log4jListener

Signals that a build has started.

buildStarted(BuildEvent) - Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder

Not used Signals that a build has started.

buildStarted(BuildEvent) - Method in class org.apache.tools.ant.taskdefs.optional.sound.AntSoundPlayer

Fired before any targets are started.

buildStarted(BuildEvent) - Method in class org.apache.tools.ant.taskdefs.Recorder

Empty implementation required by SubBuildListener interface.

buildStarted(BuildEvent) - Method in class org.apache.tools.ant.taskdefs.RecorderEntry

Signals that a build has started.

buildStarted(BuildEvent) - Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector

Signals that a build has started.

buildStarted(BuildEvent) - Method in class org.apache.tools.ant.XmlLogger

Fired when the build starts, this builds the top-level element for the document and remembers the time of the start of the build.

BuildTimeoutException - Exception in org.apache.tools.ant.taskdefs.optional.testing

This exception is used to indicate timeouts.

BuildTimeoutException() - Constructor for exception org.apache.tools.ant.taskdefs.optional.testing.BuildTimeoutException

Constructs a build exception with no descriptive information.

BuildTimeoutException(String) - Constructor for exception org.apache.tools.ant.taskdefs.optional.testing.BuildTimeoutException

Constructs an exception with the given descriptive message.

BuildTimeoutException(String, Throwable) - Constructor for exception org.apache.tools.ant.taskdefs.optional.testing.BuildTimeoutException

Constructs an exception with the given message and exception as a root cause.

BuildTimeoutException(String, Throwable, Location) - Constructor for exception org.apache.tools.ant.taskdefs.optional.testing.BuildTimeoutException

Constructs an exception with the given message and exception as a root cause and a location in a file.

BuildTimeoutException(Throwable) - Constructor for exception org.apache.tools.ant.taskdefs.optional.testing.BuildTimeoutException

Constructs an exception with the given exception as a root cause.

BuildTimeoutException(String, Location) - Constructor for exception org.apache.tools.ant.taskdefs.optional.testing.BuildTimeoutException

Constructs an exception with the given descriptive message and a location in a file.

BuildTimeoutException(Throwable, Location) - Constructor for exception org.apache.tools.ant.taskdefs.optional.testing.BuildTimeoutException

Constructs an exception with the given exception as a root cause and a location in a file.

buildUndeployArgs() - Method in class org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool

Builds the arguments to pass to weblogic.deploy for undeployment actions ("undeploy" and "delete").

BUnzip2 - Class in org.apache.tools.ant.taskdefs

Expands a file that has been compressed with the BZIP2 algorithm.

BUnzip2() - Constructor for class org.apache.tools.ant.taskdefs.BUnzip2

 

BZip2 - Class in org.apache.tools.ant.taskdefs

Compresses a file with the BZIP2 algorithm.

BZip2() - Constructor for class org.apache.tools.ant.taskdefs.BZip2

 

BZip2Constants - Interface in org.apache.tools.bzip2

Base class for both the compress and decompress classes.

BZip2Resource - Class in org.apache.tools.ant.types.resources

A Bzip2 compressed resource.

BZip2Resource() - Constructor for class org.apache.tools.ant.types.resources.BZip2Resource

A no-arg constructor

BZip2Resource(ResourceCollection) - Constructor for class org.apache.tools.ant.types.resources.BZip2Resource

Constructor with another resource to wrap.