hudson.plugins.cmake

Class CmakeBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

hudson.plugins.cmake.AbstractCmakeBuilder

hudson.plugins.cmake.CmakeBuilder

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep

public class CmakeBuilder
extends AbstractCmakeBuilder

Executes cmake as a build step.

Author:

Volker Kaiser (initial implementation), Martin Weber

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CmakeBuilder.DescriptorImpl Descriptor for CmakeBuilder.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENV_VAR_NAME_CMAKE_BUILD_TOOL the key for the build variable that holds the build tool that the build-scripts have been generated for (e.g.

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
CmakeBuilder(String installationName) Minimal constructor.
CmakeBuilder(String installationName, String generator) Deprecated. to minimize number of mandatory field values.

Method Summary

Modifier and Type	Method and Description
String	getBuildDir()
String	getBuildType()
boolean	getCleanBuild()
String	getCmakeArgs()
CmakeBuilder.DescriptorImpl	getDescriptor() Overridden for better type safety.
String	getGenerator()
String	getPreloadScript()
String	getSourceDir()
List<BuildToolStep>	getSteps() Gets the toolSteps property.
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
protected Object	readResolve()
void	setBuildDir(String buildDir)
void	setBuildType(String buildType)
void	setCleanBuild(boolean cleanBuild)
void	setCmakeArgs(String cmakeArgs)
void	setGenerator(String generator) Sets the name of the build-script generator.
void	setPreloadScript(String preloadScript)
void	setSourceDir(String sourceDir)
void	setSteps(List<BuildToolStep> toolSteps) Sets the toolSteps property.

Methods inherited from class hudson.plugins.cmake.AbstractCmakeBuilder

getArguments, getInstallationName, getSelectedInstallation, getWorkingDir, setArguments, setWorkingDir

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Field Detail

ENV_VAR_NAME_CMAKE_BUILD_TOOL

public static final String ENV_VAR_NAME_CMAKE_BUILD_TOOL

the key for the build variable that holds the build tool that the build-scripts have been generated for (e.g. /usr/bin/make or /usr/bin/ninja)

See Also:

Constant Field Values

Constructor Detail

CmakeBuilder

@DataBoundConstructor
public CmakeBuilder(String installationName)

Minimal constructor.

Parameters:

installationName - the name of the cmake tool installation from the global config page.

CmakeBuilder

@Deprecated
public CmakeBuilder(String installationName,
                                String generator)

Deprecated. to minimize number of mandatory field values.

Old constructor.

Parameters:

installationName - the name of the cmake tool installation from the global config page.

generator - the name of cmake´s buildscript generator. May be empty but not null

Method Detail

readResolve

protected Object readResolve()

setGenerator

@DataBoundSetter
public void setGenerator(String generator)

Sets the name of the build-script generator.

Parameters:

generator - the name of cmake´s build-script generator or null or empty if the default generator should be used

getGenerator

public String getGenerator()

setSourceDir

@DataBoundSetter
public void setSourceDir(String sourceDir)

getSourceDir

public String getSourceDir()

setBuildDir

@DataBoundSetter
public void setBuildDir(String buildDir)

getBuildDir

public String getBuildDir()

setBuildType

@DataBoundSetter
public void setBuildType(String buildType)

getBuildType

public String getBuildType()

setCleanBuild

@DataBoundSetter
public void setCleanBuild(boolean cleanBuild)

getCleanBuild

public boolean getCleanBuild()

setPreloadScript

@DataBoundSetter
public void setPreloadScript(String preloadScript)

getPreloadScript

public String getPreloadScript()

setCmakeArgs

@DataBoundSetter
public void setCmakeArgs(String cmakeArgs)

getCmakeArgs

public String getCmakeArgs()

setSteps

@DataBoundSetter
public void setSteps(List<BuildToolStep> toolSteps)

Sets the toolSteps property.

getSteps

public List<BuildToolStep> getSteps()

Gets the toolSteps property.

Returns:

the current toolSteps property.

perform

public boolean perform(hudson.model.AbstractBuild<?,?> build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws InterruptedException,
                       IOException

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Throws:

InterruptedException

IOException

getDescriptor

public CmakeBuilder.DescriptorImpl getDescriptor()

Overridden for better type safety.

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Builder>

Overrides:

getDescriptor in class hudson.tasks.Builder