installtoolkit.wix
Class WixTask

java.lang.Object
  Task
      installtoolkit.wix.WixTask

Direct Known Subclasses:

CandleTask, LightTask, LitTask

public abstract class WixTask
extends Task

Base task to wrap the execution of various tools from the WiX toolkit.

Author:

Christian Elberfeld

Field Summary

protected boolean	debug
protected Environment	env
protected Path	files
protected boolean	newenvironment
protected boolean	novalidate
protected boolean	showlogo
protected boolean	smalltables
protected int	verboselevel
protected boolean	warnaserror
protected int	warnlevel
protected java.io.File	wixdir
protected java.io.File	workdir

Constructor Summary

WixTask()

Method Summary

void	addEnv(Environment.Variable v) Set enviromnment variables
Path	createFiles() Files to process by the tool
void	execute()
protected abstract void	fillCommandLine(Commandline cmdl) This method must be implemented to fill additional commandline arguments
protected abstract java.lang.String	getExeName() This method must be implemented in the concrete class to retirn the name of the executable.
void	setDebug(boolean debug) Enable debug output
void	setNovalidate(boolean novalidate) Supress validation of the source files
void	setSmalltables(boolean smalltables) Use small table definitions
void	setVerboselevel(int verboselevel) Set the verbose level
void	setWarnaserror(boolean warnaserror) Thread warnings as errors
void	setWarnlevel(int warnlevel) Set the warning level
void	setWixdir(java.io.File wixDir) The directory containing the WiX binaries
void	setWorkdir(java.io.File workdir) The directory to execute the tool

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

debug

protected boolean debug

showlogo

protected boolean showlogo

warnlevel

protected int warnlevel

verboselevel

protected int verboselevel

warnaserror

protected boolean warnaserror

smalltables

protected boolean smalltables

novalidate

protected boolean novalidate

wixdir

protected java.io.File wixdir

workdir

protected java.io.File workdir

newenvironment

protected boolean newenvironment

files

protected Path files

env

protected Environment env

Constructor Detail

WixTask

public WixTask()

Method Detail

getExeName

protected abstract java.lang.String getExeName()

This method must be implemented in the concrete class to retirn the name of the executable.

fillCommandLine

protected abstract void fillCommandLine(Commandline cmdl)

This method must be implemented to fill additional commandline arguments

execute

public void execute()
             throws BuildException

Throws:

BuildException

See Also:

Task#execute()

addEnv

public void addEnv(Environment.Variable v)

Set enviromnment variables

createFiles

public Path createFiles()

Files to process by the tool

setDebug

public void setDebug(boolean debug)

Enable debug output

setWorkdir

public void setWorkdir(java.io.File workdir)

The directory to execute the tool

setWixdir

public void setWixdir(java.io.File wixDir)

The directory containing the WiX binaries

setNovalidate

public void setNovalidate(boolean novalidate)

Supress validation of the source files

setSmalltables

public void setSmalltables(boolean smalltables)

Use small table definitions

setVerboselevel

public void setVerboselevel(int verboselevel)

Set the verbose level

setWarnaserror

public void setWarnaserror(boolean warnaserror)

Thread warnings as errors

setWarnlevel

public void setWarnlevel(int warnlevel)

Set the warning level