de.berg.systeme.jenkins.wix

Class WixCommand

java.lang.Object

de.berg.systeme.jenkins.wix.WixCommand

Direct Known Subclasses:

Candle

public abstract class WixCommand
extends Object

Abstract class for building commands.

Author:

Bjoern.Berg

Field Summary

Fields

Modifier and Type	Field and Description
protected hudson.util.ArgumentListBuilder	args
protected File	exec
protected List<String>	extensions
protected hudson.Launcher	launcher
protected ToolsetLogger	lg
protected boolean	nologo
protected hudson.FilePath	outputFile
protected Map<String,String>	parameters
protected List<String>	rejectedEnvVars
protected ToolsetSettings	settings
protected List<hudson.FilePath>	sourceFiles
protected boolean	verbose
protected hudson.FilePath	workspace
protected boolean	wxall

Constructor Summary

Constructors

Constructor and Description
WixCommand(hudson.Launcher launcher, String ExeName, ToolsetSettings settings, hudson.EnvVars vars)

Method Summary

Modifier and Type	Method and Description
void	addExtension(String extensionName) extension assembly or "class, assembly".
void	addParameter(String name, String value) define a parameter for the preprocessor.
protected void	addWorkspace(hudson.FilePath workspace)
protected void	check() checks if command is properly configured.
protected abstract hudson.util.ArgumentListBuilder	createCommand() create command before execution. createCommand is used by execute().
boolean	execute() executes command and parses the output checking for errors.
boolean	exists() Checks if binary exists and toolset is properly installed.
hudson.FilePath	getOutputFile() Returns the output file generated by Wix command.
protected boolean	isEnvVarRejected(String envVar, String value)
void	setNologo(boolean nologo) skip printing logo information.
void	setOutputFile(hudson.FilePath outputFile) specify output file (default: write to current directory).
void	setVerbose(boolean verbose) verbose output.
void	setWxall(boolean wxall) treat all warnings as errors.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

lg

protected ToolsetLogger lg

exec

protected File exec

settings

protected ToolsetSettings settings

sourceFiles

protected List<hudson.FilePath> sourceFiles

parameters

protected Map<String,String> parameters

extensions

protected List<String> extensions

nologo

protected boolean nologo

outputFile

protected hudson.FilePath outputFile

verbose

protected boolean verbose

wxall

protected boolean wxall

rejectedEnvVars

protected List<String> rejectedEnvVars

launcher

protected hudson.Launcher launcher

workspace

protected hudson.FilePath workspace

args

protected hudson.util.ArgumentListBuilder args

Constructor Detail

WixCommand

public WixCommand(hudson.Launcher launcher,
                  String ExeName,
                  ToolsetSettings settings,
                  hudson.EnvVars vars)

Method Detail

isEnvVarRejected

protected boolean isEnvVarRejected(String envVar,
                                   String value)

addWorkspace

protected void addWorkspace(hudson.FilePath workspace)

addParameter

public void addParameter(String name,
                         String value)

define a parameter for the preprocessor.

Parameters:

name - name of parameter.

value - value of parameter.

addExtension

public void addExtension(String extensionName)

extension assembly or "class, assembly".

Parameters:

extensionName -

setOutputFile

public void setOutputFile(hudson.FilePath outputFile)

specify output file (default: write to current directory).

Parameters:

outputFile -

getOutputFile

public hudson.FilePath getOutputFile()

Returns the output file generated by Wix command. This can be necessary if the output file was created on remote node.

Returns:

outputFile

setVerbose

public void setVerbose(boolean verbose)

verbose output.

Parameters:

verbose - true enables verbose output (default: false)

setWxall

public void setWxall(boolean wxall)

treat all warnings as errors.

Parameters:

wxall - true enables. (default: false).

setNologo

public void setNologo(boolean nologo)

skip printing logo information.

Parameters:

nologo - set to false shows logo (default: true).

createCommand

protected abstract hudson.util.ArgumentListBuilder createCommand()
                                                          throws ToolsetException

create command before execution. createCommand is used by execute().

Throws:

ToolsetException

exists

public boolean exists()
               throws ToolsetException

Checks if binary exists and toolset is properly installed.

Returns:

true if binary exists.

Throws:

ToolsetException - if toolset is not configured.

check

protected void check()
              throws ToolsetException

checks if command is properly configured.

Throws:

ToolsetException

execute

public boolean execute()
                throws Exception,
                       ToolsetException

executes command and parses the output checking for errors.

Returns:

true if execution was successful otherwise false.

Throws:

Exception

ToolsetException

toString

public String toString()

Overrides:

toString in class Object