com.oracle.tools.packager.windows

Class WinAppBundler

java.lang.Object

com.oracle.tools.packager.AbstractBundler

com.oracle.tools.packager.AbstractImageBundler

com.oracle.tools.packager.windows.WinAppBundler

All Implemented Interfaces:

Bundler

public class WinAppBundler
extends AbstractImageBundler

Field Summary

Fields

Modifier and Type	Field and Description
static BundlerParamInfo<File>	CONFIG_ROOT
static BundlerParamInfo<File>	ICON_ICO
static BundlerParamInfo<URL>	RAW_EXECUTABLE_URL
static BundlerParamInfo<Boolean>	REBRAND_EXECUTABLE
static String	WIN_BUNDLER_PREFIX

Fields inherited from class com.oracle.tools.packager.AbstractImageBundler

CFG_FORMAT_INI, CFG_FORMAT_PROPERTIES, LAUNCHER_CFG_FORMAT

Fields inherited from class com.oracle.tools.packager.AbstractBundler

baseResourceLoader, BUNDLER_PREFIX, IMAGES_ROOT

Constructor Summary

Constructors

Constructor and Description
WinAppBundler()

Method Summary

Modifier and Type	Method and Description
boolean	bundle(Map<String,? super Object> p, File outputDirectory)
protected void	cleanupConfigFiles(Map<String,? super Object> params)
File	execute(Map<String,? super Object> params, File outputParentDir) Creates a bundle from existing content.
static void	extractFlagsFromRuntime(Map<String,? super Object> params)
void	extractRuntimeFlags(Map<String,? super Object> params)
static Collection<BundlerParamInfo<?>>	getAppBundleParameters()
Collection<BundlerParamInfo<?>>	getBundleParameters() The parameters that this bundler uses to generate it's bundle.
String	getBundleType()
protected String	getCacheLocation(Map<String,? super Object> params)
String	getDescription()
String	getID()
static String	getLauncherCfgName(Map<String,? super Object> p)
static String	getLauncherName(Map<String,? super Object> p)
String	getName()
boolean	validate(Map<String,? super Object> params) Determines if this bundler will execute with the given parameters.

Methods inherited from class com.oracle.tools.packager.AbstractImageBundler

extractFlagsFromVersion, imageBundleValidation, testRuntime, writeCfgFile

Methods inherited from class com.oracle.tools.packager.AbstractBundler

fetchResource, fetchResource, preprocessTextResource, toString

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_ROOT

public static final BundlerParamInfo<File> CONFIG_ROOT

RAW_EXECUTABLE_URL

public static final BundlerParamInfo<URL> RAW_EXECUTABLE_URL

REBRAND_EXECUTABLE

public static final BundlerParamInfo<Boolean> REBRAND_EXECUTABLE

ICON_ICO

public static final BundlerParamInfo<File> ICON_ICO

WIN_BUNDLER_PREFIX

public static final String WIN_BUNDLER_PREFIX

See Also:

Constant Field Values

Constructor Detail

WinAppBundler

public WinAppBundler()

Method Detail

validate

public boolean validate(Map<String,? super Object> params)
                 throws UnsupportedPlatformException,
                        ConfigException

Description copied from interface: Bundler

Determines if this bundler will execute with the given parameters.

Parameters:

params - The parameters to be validate. Validation may modify the map, so if you are going to be using the same map across multiple bundlers you should pass in a deep copy.

Returns:

true if valid

Throws:

UnsupportedPlatformException - If the bundler cannot run on this platform (i.e. creating mac apps on windows)

ConfigException - If the configuration params are incorrect. The exception may contain advice on how to modify the params map to make it valid.

getLauncherName

public static String getLauncherName(Map<String,? super Object> p)

getLauncherCfgName

public static String getLauncherCfgName(Map<String,? super Object> p)

cleanupConfigFiles

protected void cleanupConfigFiles(Map<String,? super Object> params)

bundle

public boolean bundle(Map<String,? super Object> p,
                      File outputDirectory)

extractRuntimeFlags

public void extractRuntimeFlags(Map<String,? super Object> params)

Specified by:

extractRuntimeFlags in class AbstractImageBundler

extractFlagsFromRuntime

public static void extractFlagsFromRuntime(Map<String,? super Object> params)

getName

public String getName()

Returns:

User Friendly name of this bundler.

getDescription

public String getDescription()

Returns:

A more verbose description of the bundler.

getID

public String getID()

Returns:

Command line identifier of the bundler. Should be unique.

getBundleType

public String getBundleType()

Returns:

The bundle type of the bundle that is created by this bundler.

getBundleParameters

public Collection<BundlerParamInfo<?>> getBundleParameters()

Description copied from interface: Bundler

The parameters that this bundler uses to generate it's bundle.

Returns:

immutable collection

getAppBundleParameters

public static Collection<BundlerParamInfo<?>> getAppBundleParameters()

execute

public File execute(Map<String,? super Object> params,
                    File outputParentDir)

Description copied from interface: Bundler

Creates a bundle from existing content. If a call to Bundler.validate(java.util.Map) date} returns true with the parameters map, then you can expect a valid output. However if an exception was thrown out of validate or it returned false then you should not expect sensible results from this call. It may or may not return a value, and it may or may not throw an exception. But any output should not be considered valid or sane.

Parameters:

params - The parameters as specified by getBundleParameters. Keyed by the id from the ParamInfo. Execution may modify the map, so if you are going to be using the same map across multiple bundlers you should pass in a deep copy.

outputParentDir - The parent dir that the returned bundle will be placed in.

Returns:

The resulting bundled file For a bundler that produces a single artifact file this will be the location of that artifact (.exe file, .deb file, etc) For a bundler that produces a specific directory format output this will be the location of that specific directory (.app file, etc). For a bundler that produce multiple files, this will be a parent directory of those files (linux and windows images), whose name is not relevant to the result.

getCacheLocation

protected String getCacheLocation(Map<String,? super Object> params)

Specified by:

getCacheLocation in class AbstractImageBundler