org.eclipse.equinox.internal.p2.publisher.eclipse

Class ProductFile

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.eclipse.equinox.internal.p2.publisher.eclipse.ProductFile

All Implemented Interfaces:

IProductDescriptor, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class ProductFile
extends org.xml.sax.helpers.DefaultHandler
implements IProductDescriptor

Used to parse a .product file.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ATTRIBUTE_FRAGMENT
protected static java.lang.String	ATTRIBUTE_ID
protected static java.lang.String	ATTRIBUTE_VERSION
protected java.util.List<FeatureEntry>	fragments
static java.lang.String	GENERIC_VERSION_NUMBER
protected java.util.List<FeatureEntry>	plugins

Fields inherited from interface org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

INCLUDED_FEATURES, ROOT_FEATURES

Constructor Summary

Constructors

Constructor and Description
ProductFile(java.lang.String location) Constructs a product file parser.
ProductFile(java.lang.String location, java.lang.String os)

Method Summary

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length)
boolean	containsPlugin(java.lang.String plugin)
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)
java.lang.String	getApplication() Returns the application identifier for this product.
java.util.List<BundleInfo>	getBundleInfos() Returns a List for each bundle that has custom configuration data in the product file.
java.util.List<IVersionedId>	getBundles(boolean includeFragments) Returns a List for each bundle that makes up this product.
java.lang.String	getConfigIniPath()
java.lang.String	getConfigIniPath(java.lang.String os) Returns the path to the config.ini file as specified in the .product file.
java.util.Properties	getConfigProperties()
java.util.Map<java.lang.String,BundleInfo>	getConfigurationInfo()
java.util.Map<java.lang.String,java.lang.String>	getConfigurationProperties() Returns the properties found in .product file.
java.util.Map<java.lang.String,java.lang.String>	getConfigurationProperties(java.lang.String os, java.lang.String arch) Returns the properties found in .product file that are valid for the specified platform os and architecture.
java.util.List<IVersionedId>	getFeatures() Returns a List of features that constitute this product.
java.util.List<IVersionedId>	getFeatures(int options) Returns the features listed in the product.
java.util.List<IVersionedId>	getFragments() Returns a list of fragments that constitute this product.
java.lang.String[]	getIcons()
java.lang.String[]	getIcons(java.lang.String os) Returns a list of icons for this product for a given OS.
java.lang.String	getId() Returns the ID for this product.
java.lang.String	getLauncherName() Gets the name of the launcher specified in the .product file.
java.lang.String	getLicenseText() Returns the license text for this product
java.lang.String	getLicenseURL() Returns the license URL for this product
java.io.File	getLocation() Gets the location of the .product file.
ProductContentType	getProductContentType() Specifies what kind of installable units (e.g. bundles, features or everything) are included in the product.
java.util.List<FeatureEntry>	getProductEntries()
java.lang.String	getProductId() Returns the Product extension point ID
java.lang.String	getProductName() Returns the product name.
java.lang.String	getProgramArguments(java.lang.String os) Returns the program arguments for a specific platform.
java.lang.String	getProgramArguments(java.lang.String os, java.lang.String arch) Returns the program arguments for a specific platform.
java.util.List<IRepositoryReference>	getRepositoryEntries() Returns a List for each update repository used by the product.
java.lang.String	getSplashLocation() Returns the location (the bundle) that defines the splash screen
java.lang.String	getVersion() Returns the version of the product
java.lang.String	getVM(java.lang.String os) Returns the VM associated as Execution Environment with the given OS.
java.lang.String	getVMArguments(java.lang.String os) Returns the VM arguments for a specific platform.
java.lang.String	getVMArguments(java.lang.String os, java.lang.String arch) Returns the VM arguments for a specific platform and architecture combination.
boolean	hasBundles(boolean includeFragments) Returns true when getBundles(includeFragments) returns a non-empty list.
boolean	hasFeatures() Returns true when getFeatures() returns a non-empty list.
boolean	haveCustomConfig()
boolean	includeLaunchers() Determines if the launchers should be included in the published product
protected void	processPlugin(org.xml.sax.Attributes attributes)
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attributes)
boolean	useFeatures() Returns true if this product is built using feature, false otherwise.

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Field Detail

GENERIC_VERSION_NUMBER

public static final java.lang.String GENERIC_VERSION_NUMBER

See Also:

Constant Field Values

ATTRIBUTE_FRAGMENT

protected static final java.lang.String ATTRIBUTE_FRAGMENT

See Also:

Constant Field Values

ATTRIBUTE_VERSION

protected static final java.lang.String ATTRIBUTE_VERSION

See Also:

Constant Field Values

ATTRIBUTE_ID

protected static final java.lang.String ATTRIBUTE_ID

See Also:

Constant Field Values

plugins

protected java.util.List<FeatureEntry> plugins

fragments

protected java.util.List<FeatureEntry> fragments

Constructor Detail

ProductFile

public ProductFile(java.lang.String location,
                   java.lang.String os)
            throws CoreException

Throws:

CoreException

ProductFile

public ProductFile(java.lang.String location)
            throws java.lang.Exception

Constructs a product file parser.

Throws:

java.lang.Exception

Method Detail

getLauncherName

public java.lang.String getLauncherName()

Gets the name of the launcher specified in the .product file.

Specified by:

getLauncherName in interface IProductDescriptor

getLocation

public java.io.File getLocation()

Gets the location of the .product file.

Specified by:

getLocation in interface IProductDescriptor

getConfigurationProperties

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

Returns the properties found in .product file. Properties are located in the block of the file

Specified by:

getConfigurationProperties in interface IProductDescriptor

getConfigurationProperties

public java.util.Map<java.lang.String,java.lang.String> getConfigurationProperties(java.lang.String os,
                                                                                   java.lang.String arch)

Returns the properties found in .product file that are valid for the specified platform os and architecture. If there is no platform os and/or architecture specified, return only the properties that are not filtered by the unspecified os and/or arch. Properties are located in the block of the file

Specified by:

getConfigurationProperties in interface IProductDescriptor

getBundles

public java.util.List<IVersionedId> getBundles(boolean includeFragments)

Returns a List for each bundle that makes up this product.

Specified by:

getBundles in interface IProductDescriptor

Parameters:

includeFragments - Indicates whether or not fragments should be included in the list

Returns:

the list of bundles in this product.

hasBundles

public boolean hasBundles(boolean includeFragments)

Description copied from interface: IProductDescriptor

Returns true when getBundles(includeFragments) returns a non-empty list.

Specified by:

hasBundles in interface IProductDescriptor

getBundleInfos

public java.util.List<BundleInfo> getBundleInfos()

Returns a List for each bundle that has custom configuration data in the product file.

Specified by:

getBundleInfos in interface IProductDescriptor

Returns:

A List

getFragments

public java.util.List<IVersionedId> getFragments()

Returns a list of fragments that constitute this product.

Specified by:

getFragments in interface IProductDescriptor

See Also:

IProductDescriptor.useFeatures()

getFeatures

public java.util.List<IVersionedId> getFeatures()

Returns a List of features that constitute this product.

Specified by:

getFeatures in interface IProductDescriptor

hasFeatures

public boolean hasFeatures()

Description copied from interface: IProductDescriptor

Returns true when getFeatures() returns a non-empty list.

Specified by:

hasFeatures in interface IProductDescriptor

getFeatures

public java.util.List<IVersionedId> getFeatures(int options)

Description copied from interface: IProductDescriptor

Returns the features listed in the product. Note: These features are only part of the product if IProductDescriptor.useFeatures() returns true.

Specified by:

getFeatures in interface IProductDescriptor

Parameters:

options - bitmask to indicate what kind of features to return.

See Also:

IProductDescriptor.INCLUDED_FEATURES, IProductDescriptor.ROOT_FEATURES

getProductEntries

public java.util.List<FeatureEntry> getProductEntries()

containsPlugin

public boolean containsPlugin(java.lang.String plugin)

getIcons

public java.lang.String[] getIcons()

getIcons

public java.lang.String[] getIcons(java.lang.String os)

Description copied from interface: IProductDescriptor

Returns a list of icons for this product for a given OS.

Specified by:

getIcons in interface IProductDescriptor

getConfigIniPath

public java.lang.String getConfigIniPath(java.lang.String os)

Description copied from interface: IProductDescriptor

Returns the path to the config.ini file as specified in the .product file.

Specified by:

getConfigIniPath in interface IProductDescriptor

getConfigIniPath

public java.lang.String getConfigIniPath()

haveCustomConfig

public boolean haveCustomConfig()

getId

public java.lang.String getId()

Returns the ID for this product.

Specified by:

getId in interface IProductDescriptor

getProductId

public java.lang.String getProductId()

Description copied from interface: IProductDescriptor

Returns the Product extension point ID

Specified by:

getProductId in interface IProductDescriptor

getSplashLocation

public java.lang.String getSplashLocation()

Returns the location (the bundle) that defines the splash screen

Specified by:

getSplashLocation in interface IProductDescriptor

getProductName

public java.lang.String getProductName()

Returns the product name.

Specified by:

getProductName in interface IProductDescriptor

getApplication

public java.lang.String getApplication()

Returns the application identifier for this product.

Specified by:

getApplication in interface IProductDescriptor

useFeatures

public boolean useFeatures()

Returns true if this product is built using feature, false otherwise.

Specified by:

useFeatures in interface IProductDescriptor

getVersion

public java.lang.String getVersion()

Returns the version of the product

Specified by:

getVersion in interface IProductDescriptor

includeLaunchers

public boolean includeLaunchers()

Description copied from interface: IProductDescriptor

Determines if the launchers should be included in the published product

Specified by:

includeLaunchers in interface IProductDescriptor

getConfigurationInfo

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

getConfigProperties

public java.util.Properties getConfigProperties()

getVMArguments

public java.lang.String getVMArguments(java.lang.String os)

Returns the VM arguments for a specific platform. If the empty string is used for the OS, this returns the default VM arguments

Specified by:

getVMArguments in interface IProductDescriptor

getVMArguments

public java.lang.String getVMArguments(java.lang.String os,
                                       java.lang.String arch)

Returns the VM arguments for a specific platform and architecture combination. If the empty string is used for the architecture, this returns the default arguments for the platform. If the empty string is used for the OS, this returns the default VM arguments.

Specified by:

getVMArguments in interface IProductDescriptor

getProgramArguments

public java.lang.String getProgramArguments(java.lang.String os)

Returns the program arguments for a specific platform. If the empty string is used for the OS, this returns the default program arguments

Specified by:

getProgramArguments in interface IProductDescriptor

getProgramArguments

public java.lang.String getProgramArguments(java.lang.String os,
                                            java.lang.String arch)

Returns the program arguments for a specific platform. If the empty string is used for the OS, this returns the default program arguments

Specified by:

getProgramArguments in interface IProductDescriptor

getLicenseText

public java.lang.String getLicenseText()

Description copied from interface: IProductDescriptor

Returns the license text for this product

Specified by:

getLicenseText in interface IProductDescriptor

getLicenseURL

public java.lang.String getLicenseURL()

Description copied from interface: IProductDescriptor

Returns the license URL for this product

Specified by:

getLicenseURL in interface IProductDescriptor

getRepositoryEntries

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

Description copied from interface: IProductDescriptor

Returns a List for each update repository used by the product.

Specified by:

getRepositoryEntries in interface IProductDescriptor

Returns:

A List

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes attributes)

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

characters

public void characters(char[] ch,
                       int start,
                       int length)

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

getVM

public java.lang.String getVM(java.lang.String os)

Description copied from interface: IProductDescriptor

Returns the VM associated as Execution Environment with the given OS.

Specified by:

getVM in interface IProductDescriptor

Parameters:

os - the OS

Returns:

the VM for this OS, null if none is set

processPlugin

protected void processPlugin(org.xml.sax.Attributes attributes)

getProductContentType

public ProductContentType getProductContentType()

Description copied from interface: IProductDescriptor

Specifies what kind of installable units (e.g. bundles, features or everything) are included in the product.

Specified by:

getProductContentType in interface IProductDescriptor