org.apache.ant.dotnet.wix
Class WixTask

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by org.apache.ant.dotnet.wix.WixTask
All Implemented Interfaces:
java.lang.Cloneable

public class WixTask
extends org.apache.tools.ant.Task

Task to run the WiX utility to create MSI files from an XML description.

See Also:
http://sf.net/projects/wix

Nested Class Summary
static class WixTask.Mode
           
 
Field Summary
 
Fields inherited from class org.apache.tools.ant.Task
taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
 
Constructor Summary
WixTask()
           
 
Method Summary
 void addCandleParameter(AbstractBuildTask.Property t)
          A parameter to pass to candle.exe.
 void addLightParameter(AbstractBuildTask.Property t)
          A parameter to pass to light.exe.
 void addMoreSources(org.apache.tools.ant.types.FileSet fs)
          A set of additional source files (include files in the case of candle, or media/files/whatever in the case of light).
 void addSources(org.apache.tools.ant.types.FileSet fs)
          A set of source files.
 org.apache.tools.ant.types.Commandline.Argument createCandleArg()
          Adds a command-line argument for candle.exe.
 org.apache.tools.ant.types.Commandline.Argument createLightArg()
          Adds a command-line argument for light.exe.
 void execute()
           
 void setMode(WixTask.Mode m)
          Whether to run candle, light or both.
 void setSource(java.io.File f)
          The main source file.
 void setTarget(java.io.File f)
          The main target file.
 void setUseLit(boolean b)
          Instructs the task to use lit.exe rather than light.exe as "compiler".
 void setVm(java.lang.String value)
          Set the name of the executable for the virtual machine.
 void setWixHome(java.io.File f)
          Sets the installation directory of WiX.
 void setWixobjDestDir(java.io.File f)
          Sets the destination directory for wixobj files generated by candle.
 
Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WixTask

public WixTask()
Method Detail

setVm

public void setVm(java.lang.String value)
Set the name of the executable for the virtual machine.

Parameters:
value - the name of the executable for the virtual machine

setSource

public void setSource(java.io.File f)
The main source file.

candle may include more files than this one, the main source is the one passed on the command line.

Parameters:
File - object of the main source file.

setTarget

public void setTarget(java.io.File f)
The main target file.

Parameters:
File - object of the main target file.

addSources

public void addSources(org.apache.tools.ant.types.FileSet fs)
A set of source files.


addMoreSources

public void addMoreSources(org.apache.tools.ant.types.FileSet fs)
A set of additional source files (include files in the case of candle, or media/files/whatever in the case of light).

Unlike the files specified as sources, these will not be passed on the command line, they only help Ant to determine whether the target is out-of-date.


setWixHome

public void setWixHome(java.io.File f)
Sets the installation directory of WiX.

If omitted, Ant will assume that WiX's executables can be found on the PATH.


setMode

public void setMode(WixTask.Mode m)
Whether to run candle, light or both.


setWixobjDestDir

public void setWixobjDestDir(java.io.File f)
Sets the destination directory for wixobj files generated by candle.

Let's candle decide and assumes they'll be created in the current working directory.


addCandleParameter

public final void addCandleParameter(AbstractBuildTask.Property t)
A parameter to pass to candle.exe.


addLightParameter

public final void addLightParameter(AbstractBuildTask.Property t)
A parameter to pass to light.exe.


createLightArg

public org.apache.tools.ant.types.Commandline.Argument createLightArg()
Adds a command-line argument for light.exe.

Returns:
new command line argument created.

createCandleArg

public org.apache.tools.ant.types.Commandline.Argument createCandleArg()
Adds a command-line argument for candle.exe.

Returns:
new command line argument created.

setUseLit

public void setUseLit(boolean b)
Instructs the task to use lit.exe rather than light.exe as "compiler".

Since:
.NET Antlib 1.1

execute

public void execute()
Overrides:
execute in class org.apache.tools.ant.Task