Package com.github.wix_maven

Class HarvestMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.wix_maven.AbstractWixMojo

com.github.wix_maven.AbstractPackageable

com.github.wix_maven.HarvestMojo

All Implemented Interfaces:

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

@Mojo(name="harvest",
      defaultPhase=GENERATE_SOURCES,
      requiresDependencyResolution=COMPILE)
public class HarvestMojo
extends AbstractPackageable

Generates WiX authoring from various input formats. Every time heat is run it regenerates the output file and any changes are lost.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	generateBinderVariables	Generate binder variables (true) instead of preprocessor variables (false).
protected boolean	generateComponentGUIDs	Generate Component GUID now during heat (true) [-gg] or later during link (false) [autogenerate -ag]
protected boolean	generateGUIDBrackets	Generate component guids curly braces.
protected boolean	generateHarvestSourceVarName	Generate harvestSourceVar based on harvest id
protected boolean	harvestKeepEmpty	Keep empty directories.
protected boolean	harvestSuppressRegistryHarvesting	Suppress registry harvesting.
protected boolean	harvestSuppressRootDirectoryElement	Suppress harvesting the root directory as an element.
protected boolean	harvestSuppressUniqueIdentifiers	Suppress unique identifiers for files, components, and directories.
protected String	harvestTemplate	Use template, [-template] one of: fragment module product
static final String	HT_DIR
static final String	HT_FILE
static final String	HT_PERFORMANCE
static final String	HT_PROJECT
static final String	HT_REGISTRY
static final String	HT_WEBSITE

Fields inherited from class com.github.wix_maven.AbstractPackageable

cabCacheDirectory, externalCabs, mergeLevel, ML_BASE, ML_DEFAULT, ML_REPACK, ML_TRANSFORM, narUnpackDirectory, outputDirectory, packLevel, PL_CACHED_CAB, PL_CULTURE_CAB, PL_DEFAULT, PL_MST, PL_PACKAGE, PL_TRANS_CAB, PL_WIXPDB

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
HarvestMojo()

Method Summary

Modifier and Type	Method	Description
protected void	addToolsetOptions(org.codehaus.plexus.util.cli.Commandline cl)
void	execute()
protected void	heat(org.codehaus.plexus.util.cli.Commandline cl)
void	multiHeat(File heatTool, String harvestType, File harvest)

Methods inherited from class com.github.wix_maven.AbstractPackageable

alternateCulturespecs, baseCulturespec, defaultLocale, getExternalCabs, getOutput, getPackageOutputExtension, getPackaging, languages

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

HT_DIR

public static final String HT_DIR

See Also:

• Constant Field Values

HT_FILE

public static final String HT_FILE

See Also:

• Constant Field Values

HT_PROJECT

public static final String HT_PROJECT

See Also:

• Constant Field Values

HT_WEBSITE

public static final String HT_WEBSITE

See Also:

• Constant Field Values

HT_PERFORMANCE

public static final String HT_PERFORMANCE

See Also:

• Constant Field Values

HT_REGISTRY

public static final String HT_REGISTRY

See Also:

• Constant Field Values

generateHarvestSourceVarName

@Parameter(defaultValue="false")
protected boolean generateHarvestSourceVarName

Generate harvestSourceVar based on harvest id

generateComponentGUIDs

@Parameter(defaultValue="false")
protected boolean generateComponentGUIDs

Generate Component GUID now during heat (true) [-gg] or later during link (false) [autogenerate -ag]

generateGUIDBrackets

@Parameter(defaultValue="true")
protected boolean generateGUIDBrackets

Generate component guids curly braces. Setting to false [-g1].

generateBinderVariables

@Parameter(defaultValue="false")
protected boolean generateBinderVariables

Generate binder variables (true) instead of preprocessor variables (false). [-wixvar]

harvestKeepEmpty

@Parameter(defaultValue="false")
protected boolean harvestKeepEmpty

Keep empty directories. Setting to true [-ke]

harvestSuppressRootDirectoryElement

@Parameter(defaultValue="false")
protected boolean harvestSuppressRootDirectoryElement

Suppress harvesting the root directory as an element. Setting to true [-srd]

harvestSuppressUniqueIdentifiers

@Parameter(defaultValue="false")
protected boolean harvestSuppressUniqueIdentifiers

Suppress unique identifiers for files, components, and directories.

harvestSuppressRegistryHarvesting

@Parameter(defaultValue="false")
protected boolean harvestSuppressRegistryHarvesting

Suppress registry harvesting.

harvestTemplate

@Parameter(defaultValue="fragment")
protected String harvestTemplate

Use template, [-template] one of:

• fragment
• module
• product

Constructor Details

HarvestMojo

public HarvestMojo()

Method Details

addToolsetOptions

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

multiHeat

public void multiHeat(File heatTool,
 String harvestType,
 File harvest)
               throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

heat

protected void heat(org.codehaus.plexus.util.cli.Commandline cl)
             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException