org.eclipse.equinox.p2.publisher.eclipse

Class ProductFileAdvice

java.lang.Object

AbstractAdvice

org.eclipse.equinox.p2.publisher.eclipse.ProductFileAdvice

All Implemented Interfaces:

IBrandingAdvice, IConfigAdvice, IExecutableAdvice

public class ProductFileAdvice
extends AbstractAdvice
implements IExecutableAdvice, IConfigAdvice, IBrandingAdvice

Provide advice derived from the .product file. The product can give some info on launching as well as the configuration (bundles, properties, ...)

Constructor Summary

Constructors

Constructor and Description
ProductFileAdvice(IProductDescriptor product, java.lang.String configSpec) Constructs a new ProductFileAdvice for a given product file and a particular configuration.

Method Summary

Modifier and Type	Method and Description
BundleInfo[]	getBundles()
protected java.lang.String	getConfigSpec()
java.lang.String	getExecutableName() Returns the name of the launcher.
java.lang.String[]	getIcons() Returns the icons defined for this product
protected java.lang.String	getId()
java.lang.String	getLicenseText() Returns the license URL for this product
java.lang.String	getLicenseURL() Returns the license text for this product
java.lang.String	getOS() Returns the operating system that this advice is configured to work with.
IProductDescriptor	getProductFile() Returns the product file parser that this advice is working on
java.lang.String[]	getProgramArguments() Returns the program arguments for this product.
java.util.Map<java.lang.String,java.lang.String>	getProperties() Returns the properties associated with this product.
java.util.List<IRepositoryReference>	getUpdateRepositories() Returns the update repositories for this product
protected Version	getVersion()
java.lang.String[]	getVMArguments() Returns the VM arguments for this product.
protected boolean	matchConfig(java.lang.String spec, boolean includeDefault)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProductFileAdvice

public ProductFileAdvice(IProductDescriptor product,
                         java.lang.String configSpec)

Constructs a new ProductFileAdvice for a given product file and a particular configuration. Configurations are specified as: ws.os.arch where: ws is the windowing system os is the operating system arch is the architecture

Method Detail

getId

protected java.lang.String getId()

getVersion

protected Version getVersion()

getProgramArguments

public java.lang.String[] getProgramArguments()

Returns the program arguments for this product.

Specified by:

getProgramArguments in interface IExecutableAdvice

Returns:

The list of program arguments for tihs executable or empty array for none

getVMArguments

public java.lang.String[] getVMArguments()

Returns the VM arguments for this product.

Specified by:

getVMArguments in interface IExecutableAdvice

Returns:

The list of VM Arguments for this executable or empty array for none

getBundles

public BundleInfo[] getBundles()

Specified by:

getBundles in interface IConfigAdvice

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

Returns the properties associated with this product. These properties may be defined in the .product file, the config.ini file, or both.

Specified by:

getProperties in interface IConfigAdvice

getExecutableName

public java.lang.String getExecutableName()

Returns the name of the launcher. This should be the OS-independent name. That is, ".exe" etc. should not be included.

Specified by:

getExecutableName in interface IBrandingAdvice

Specified by:

getExecutableName in interface IExecutableAdvice

Returns:

the name of the branded launcher or null if none.

getProductFile

public IProductDescriptor getProductFile()

Returns the product file parser that this advice is working on

getIcons

public java.lang.String[] getIcons()

Returns the icons defined for this product

Specified by:

getIcons in interface IBrandingAdvice

Returns:

the list of icons used in branding an executable or null if none.

getOS

public java.lang.String getOS()

Returns the operating system that this advice is configured to work with.

Specified by:

getOS in interface IBrandingAdvice

getLicenseURL

public java.lang.String getLicenseURL()

Returns the license text for this product

getLicenseText

public java.lang.String getLicenseText()

Returns the license URL for this product

getUpdateRepositories

public java.util.List<IRepositoryReference> getUpdateRepositories()

Returns the update repositories for this product

getConfigSpec

protected java.lang.String getConfigSpec()

matchConfig

protected boolean matchConfig(java.lang.String spec,
                              boolean includeDefault)