de.berg.systeme.jenkins.wix

Class Toolset

java.lang.Object

de.berg.systeme.jenkins.wix.Toolset

public final class Toolset
extends Object

Toolset checks the existence for the WIX Toolset on the buildsystem. If not available an exception is thrown.

It is used to compile and link wsx-files in a batch mannor triggered by the WixToolsetBuilder.

Version:

2.0

Author:

Bjoern Berg, bjoern.berg@gmx.de

Constructor Summary

Constructors

Constructor and Description
Toolset(ToolsetSettings properties) constructor with global settings.
Toolset(ToolsetSettings properties, hudson.EnvVars vars) constructor with global settings and environment variables.

Method Summary

Methods

Modifier and Type	Method and Description
hudson.FilePath	compile(hudson.FilePath file) Compiles the given source file.
hudson.FilePath	compile(hudson.FilePath[] input) Compiles a set of source files.
hudson.FilePath	compile(hudson.FilePath[] input, hudson.FilePath output) Compiles a set of source files into a given object file.
void	link() Deprecated. use link(FilePath).
hudson.FilePath	link(hudson.FilePath file) Links the given object file into an MSI package.
hudson.FilePath	link(hudson.FilePath[] input) Links a set of given object files into an MSI package.
hudson.FilePath	link(hudson.FilePath[] input, hudson.FilePath output) Links a set of given object files into an MSI package.
hudson.FilePath	link(hudson.FilePath input, hudson.FilePath output) Wrapper method for link.
void	setArchitecture(String cpu)

Methods inherited from class java.lang.Object

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

Constructor Detail

Toolset

public Toolset(ToolsetSettings properties)
        throws ToolsetException

constructor with global settings.

Parameters:

properties - global settings.

Throws:

ToolsetException

Toolset

public Toolset(ToolsetSettings properties,
       hudson.EnvVars vars)
        throws ToolsetException

constructor with global settings and environment variables.

Parameters:

properties - global settings.

vars - environment variables.

Throws:

ToolsetException

Method Detail

setArchitecture

public void setArchitecture(String cpu)

compile

public hudson.FilePath compile(hudson.FilePath file)
                        throws ToolsetException,
                               Exception

Compiles the given source file.

Parameters:

file - source file to compile.

Throws:

ToolsetException - throws an exception if process fails.

Exception

compile

public hudson.FilePath compile(hudson.FilePath[] input)
                        throws Exception,
                               ToolsetException

Compiles a set of source files.

Parameters:

input - set of source files.

Returns:

compiled object file.

Throws:

Exception

ToolsetException

compile

public hudson.FilePath compile(hudson.FilePath[] input,
                      hudson.FilePath output)
                        throws Exception,
                               ToolsetException

Compiles a set of source files into a given object file.

Parameters:

input - set of source files.

output - object file.

Returns:

object file if successful. Otherwise null.

Throws:

Exception

ToolsetException

link

public void link()
          throws ToolsetException,
                 Exception

Deprecated. use link(FilePath).

Throws:

ToolsetException

Exception

link

public hudson.FilePath link(hudson.FilePath file)
                     throws Exception,
                            ToolsetException

Links the given object file into an MSI package.

Parameters:

file - object file.

Returns:

MSI package file.

Throws:

Exception

ToolsetException

link

public hudson.FilePath link(hudson.FilePath[] input)
                     throws Exception,
                            ToolsetException

Links a set of given object files into an MSI package.

Parameters:

input - set of object files.

Returns:

MSI package file.

Throws:

Exception

ToolsetException

link

public hudson.FilePath link(hudson.FilePath[] input,
                   hudson.FilePath output)
                     throws Exception,
                            ToolsetException

Links a set of given object files into an MSI package.

Parameters:

input - set of object files.

output - name of MSI package.

Returns:

MSI package file.

Throws:

Exception

ToolsetException

link

public hudson.FilePath link(hudson.FilePath input,
                   hudson.FilePath output)
                     throws Exception,
                            ToolsetException

Wrapper method for link.

Parameters:

input - input FilePath

output - output FilePath

Returns:

FilePath to output file used to link to (can be different from defined output)

Throws:

Exception

ToolsetException