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 StringBuffer	cmd
protected File	exec
protected List<String>	extensions
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 boolean	wxall

Constructor Summary

Constructors

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

Method Summary

Methods

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	addRejectedEnvVar(String envVar)
protected void	appendExtensions()
protected void	appendParameters()
protected void	appendSources()
protected void	check() checks if command is properly configured.
protected void	clean() creates new StringBuffer.
protected abstract void	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.
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.

Methods inherited from class java.lang.Object

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

Field Detail

lg

protected ToolsetLogger lg

exec

protected File exec

settings

protected ToolsetSettings settings

cmd

protected StringBuffer cmd

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

Constructor Detail

WixCommand

public WixCommand(ToolsetSettings settings,
          hudson.EnvVars vars)

WixCommand

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

Method Detail

addRejectedEnvVar

protected void addRejectedEnvVar(String envVar)

isEnvVarRejected

protected boolean isEnvVarRejected(String envVar,
                       String value)

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 -

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 void 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.

appendExtensions

protected void appendExtensions()

appendParameters

protected void appendParameters()

appendSources

protected void appendSources()

clean

protected void clean()

creates new StringBuffer.

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