Package com.github.wix_maven

Class CandleMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.wix_maven.AbstractWixMojo

com.github.wix_maven.AbstractCompilerMojo

com.github.wix_maven.CandleMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="candle",
      requiresProject=true,
      defaultPhase=COMPILE,
      requiresDependencyResolution=COMPILE)
public class CandleMojo
extends AbstractCompilerMojo

Goal which executes WiX candle to create a .wixobj file. The following project dependency inclusion patterns apply
Dependent NAR project 'Foo' with possible nar output redefined as 'bar'

• -dFoo.TargetDir=Foo-version\
• -dFoo.TargetExt=.wixlib
• -dFoo.TargetFileName=bar.type
• -dFoo.TargetName=bar

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RESPONSE_FILE_NAME	The name of the response file.
protected int	staleMillis	The granularity in milliseconds of the last modification date for testing whether a source needs re-compilation
protected File	timestampDirectory	The directory to store the time-stamp file for the processed aid files.
protected String	timestampFile	Set this value if you wish to have a single timestamp file to track changes rather than cxx,hxx comparison. The time-stamp file for the processed xsd files.

Fields inherited from class com.github.wix_maven.AbstractWixMojo

compilePerLocale, harvestInputDirectory, intDirectory, localeList, PACK_BUNDLE, PACK_INSTALL, PACK_LIB, PACK_MERGE, PACK_MSIX, PACK_PATCH, packaging, project, reactorProjects, relativeBase, remoteArtifactRepositories, remoteRepos, repoSession, repoSystem, skip, suppress, toolDirectory, toolDirectoryOverwrite, toolsPluginArtifactId, unpackDirectory, validate, verbose, warn, wixExtensions, wxsGeneratedDirectory, wxsInputDirectory, zipUnArchiver

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
CandleMojo()

Method Summary

Modifier and Type	Method	Description
protected void	addDefinition(String def)
protected void	addOtherOptions(org.codehaus.plexus.util.cli.Commandline cl)
protected void	compile(File responseFile, String arch, String culture)
protected void	createCommonResponseFile()
void	execute()
final Set<String>	getExcludes()
final Set<String>	getIncludes()

Methods inherited from class com.github.wix_maven.AbstractCompilerMojo

addHarvestDefine, addHarvestDefines, addJARDefines, addNARDefines, addNPANDAYDefines, addResource, addWixDefines, defineRepoFile, defineWixUnpackFile, getNARDependencySets

Methods inherited from class com.github.wix_maven.AbstractWixMojo

addExtension, addToolsetGeneralOptions, addWixExtensions, cleanupFileBasedResources, culturespecs, findToolsArtifact, findToolsArtifacts, getArchIntDirectory, getCommandBuilder, getExtDependencySets, getJARDependencySets, getLocales, getNPANDAYDependencySets, getOutput, getOutputPath, getPlatforms, getPrimaryCulture, getRelatedArtifacts, getRelative, getRelativePath, getWixDependencySets, getWixVersion, resolveArtifact, resolveArtifact, setLocales, setPlatforms, unpackFileBasedResources, wixUnpackDirectory

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Details

RESPONSE_FILE_NAME

public static final String RESPONSE_FILE_NAME

The name of the response file.

See Also:

• Constant Field Values

staleMillis

@Parameter(property="wix.staleMillis",
           defaultValue="1000",
           required=true)
protected int staleMillis

The granularity in milliseconds of the last modification date for testing whether a source needs re-compilation

timestampFile

@Parameter(property="wix.timestampFile")
protected String timestampFile

Set this value if you wish to have a single timestamp file to track changes rather than cxx,hxx comparison.
The time-stamp file for the processed xsd files.

timestampDirectory

@Parameter(property="wix.timestampDirectory",
           defaultValue="${project.build.directory}/mapping/cpp")
protected File timestampDirectory

The directory to store the time-stamp file for the processed aid files.
Defaults to outputDirectory.
Only used with xsdTimestampFile being set.

Constructor Details

CandleMojo

public CandleMojo()

Method Details

getIncludes

public final Set<String> getIncludes()

getExcludes

public final Set<String> getExcludes()

addOtherOptions

protected void addOtherOptions(org.codehaus.plexus.util.cli.Commandline cl)

compile

protected void compile(File responseFile,
 String arch,
 String culture)
                throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

addDefinition

protected void addDefinition(String def)

Specified by:

addDefinition in class AbstractCompilerMojo

createCommonResponseFile

protected void createCommonResponseFile()
                                 throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException