Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.pmease.quickbuild.builder
Class AntBuilder

    java.lang.Object
      com.pmease.quickbuild.builder.Builder
          com.pmease.quickbuild.builder.AntBuilder

All Implemented Interfaces:
  java.io.Serializable

public class AntBuilder
extends Builder

Ant builder implementation

Author:
  robin shine
See Also:
  Serialized Form

Constructor Summary
`AntBuilder()`

Method Summary
`java.lang.String` | `constructBuildCmd(Build build)` Construct antExecutablePath to run ant
`java.lang.String` | `constructBuildCmdDir(Build build)` Constructs the directory to run build command in
`java.lang.String` | `getAntExecutablePath()` OGNL: Specify command to run ant.
`java.util.Map` | `getBuildProperties()` OGNL: Define build properties here to pass into the ant build script.
`java.lang.String` | `getBuildScriptPath()` OGNL: The path for the Ant build script.
`java.lang.String` | `getDirToRunAnt()` Optionally specify the directory to run Ant in.
`java.lang.String` | `getExtraAntOptions()` Optionally specify extra Ant options.
`java.lang.String` | `getTargets()` OGNL: Specify the targets to build.
`void` | `setAntExecutablePath(java.lang.String antExecutablePath)`
`void` | `setBuildProperties(java.util.Map buildProperties)`
`void` | `setBuildScriptPath(java.lang.String buildScriptPath)`
`void` | `setDirToRunAnt(java.lang.String dirToRunAnt)`
`void` | `setExtraAntOptions(java.lang.String extraAntOptions)`
`void` | `setTargets(java.lang.String targets)`

Methods inherited from class com.pmease.quickbuild.builder.Builder
`equals, execute, getBuildSuccessCondition, getBuildSuccessConditionChoices, getEditor, getEnvironments, getName, getNameChoices, getResult, hashCode, logContainsLine, setBuildSuccessCondition, setEditor, setEnvironments, setName, validate`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### AntBuilder

    public AntBuilder()

Method Detail

### getAntExecutablePath

    public java.lang.String getAntExecutablePath()

  OGNL: Specify command to run ant. For example, C:\\apache-ant-1.6.2\\bin\\ant.bat
  NOTE: Command or arguement with spaces should be quoted.

  Returns:

### setAntExecutablePath

    public void setAntExecutablePath(java.lang.String antExecutablePath)

### getBuildScriptPath

    public java.lang.String getBuildScriptPath()

  OGNL: The path for the Ant build script. If this path is not an absolute path, it is assumed that it is relative to the current configuration's checkouts directory. Refer to the user's guide for details about how to write a new Ant build file or how to modify your existing Ant build script.

  Returns:

### setBuildScriptPath

    public void setBuildScriptPath(java.lang.String buildScriptPath)

### getTargets

    public java.lang.String getTargets()

  OGNL: Specify the targets to build. Use space to separate different targets (target name containing spaces should be quoted in order not to be interpreted as multiple targets). You can also use ${...} to pass variables to the target name. For example you can use ${name} to reference name of current configuration. For valid OGNL expressions in this context, please refer to the user's guide.

  Returns:

### setTargets

    public void setTargets(java.lang.String targets)

### getBuildProperties

    public java.util.Map getBuildProperties()

  OGNL: Define build properties here to pass into the ant build script. For example:
  buildVersion=${build.version}
  configurationName=${name}
  You should set one variable per line. OGNL expression can be inserted to form the value provided they are enclosed by ${...}. For valid OGNL expressions in this context, please refer to the user's guide.
  NOTE: Properties with blank value will be ignored.

  Returns:

### setBuildProperties

    public void setBuildProperties(java.util.Map buildProperties)

### constructBuildCmd

    public java.lang.String constructBuildCmd(Build build)

  Construct antExecutablePath to run ant

  Specified by:
    `constructBuildCmd` in class `Builder`
  Returns:

### constructBuildCmdDir

    public java.lang.String constructBuildCmdDir(Build build)

  Description copied from class: `Builder`
  Constructs the directory to run build command in

  Specified by:
    `constructBuildCmdDir` in class `Builder`
  Returns:
    the directory to run build command in. Null if do not care where to run build command

### getDirToRunAnt

    public java.lang.String getDirToRunAnt()

  Optionally specify the directory to run Ant in. If not specified, Ant will be executed in the directory containing the build script you specified.

  Returns:

### setDirToRunAnt

    public void setDirToRunAnt(java.lang.String dirToRunAnt)

### getExtraAntOptions

    public java.lang.String getExtraAntOptions()

  Optionally specify extra Ant options.

  Returns:

### setExtraAntOptions

    public void setExtraAntOptions(java.lang.String extraAntOptions)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2005 PMEase Inc. All Rights Reserved.