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

java.lang.Object
  org.xml.sax.helpers.DefaultHandler
      copied.org.eclipse.equinox.internal.p2.publisher.eclipse.ProductFile

All Implemented Interfaces:

org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor, ContentHandler, DTDHandler, EntityResolver, ErrorHandler

Direct Known Subclasses:

ProductFile2

public class ProductFile
extends org.xml.sax.helpers.DefaultHandler
implements org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

Used to parse a .product file.

Field Summary

protected static String	ATTRIBUTE_FRAGMENT
protected static String	ATTRIBUTE_ID
protected static String	ATTRIBUTE_VERSION
protected List<org.eclipse.equinox.p2.metadata.IVersionedId>	fragments
protected List<org.eclipse.equinox.p2.metadata.IVersionedId>	plugins

Constructor Summary

ProductFile(String location)
Constructs a product file parser.

Method Summary

void	characters(char[] ch, int start, int length)
void	endElement(String uri, String localName, String qName)
String	getApplication() Returns the application identifier for this product.
List<org.eclipse.equinox.frameworkadmin.BundleInfo>	getBundleInfos() Returns a List for each bundle that has custom configuration data in the product file.
List<org.eclipse.equinox.p2.metadata.IVersionedId>	getBundles(boolean includeFragments) Returns a List for each bundle that makes up this product.
String	getConfigIniPath()
String	getConfigIniPath(String os)
Map<String,String>	getConfigurationProperties() Returns the properties found in .product file.
List<org.eclipse.equinox.p2.metadata.IVersionedId>	getFeatures() Returns a List of features that constitute this product.
List<org.eclipse.equinox.p2.metadata.IVersionedId>	getFragments() Returns a list of fragments that constitute this product.
String[]	getIcons(String os)
String	getId() Returns the ID for this product.
String	getLauncherName() Gets the name of the launcher specified in the .product file.
String	getLicenseText()
String	getLicenseURL()
File	getLocation() Gets the location of the .product file.
String	getProductId()
String	getProductName() Returns the product name.
String	getProgramArguments(String os) Returns the program arguments for a specific platform.
String	getSplashLocation() Returns the location (the bundle) that defines the splash screen
String	getVersion() Returns the version of the product
String	getVMArguments(String os) Returns the VM arguments for a specific platform.
protected void	processPlugin(Attributes attributes)
void	startElement(String uri, String localName, String qName, 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

ATTRIBUTE_FRAGMENT

protected static final String ATTRIBUTE_FRAGMENT

See Also:

Constant Field Values

ATTRIBUTE_VERSION

protected static final String ATTRIBUTE_VERSION

See Also:

Constant Field Values

ATTRIBUTE_ID

protected static final String ATTRIBUTE_ID

See Also:

Constant Field Values

plugins

protected List<org.eclipse.equinox.p2.metadata.IVersionedId> plugins

fragments

protected List<org.eclipse.equinox.p2.metadata.IVersionedId> fragments

Constructor Detail

ProductFile

public ProductFile(String location)
            throws Exception

Constructs a product file parser.

Throws:

Exception

Method Detail

getLauncherName

public String getLauncherName()

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

Specified by:

getLauncherName in interface org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

getLocation

public File getLocation()

Gets the location of the .product file.

Specified by:

getLocation in interface org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

getConfigurationProperties

public Map<String,String> getConfigurationProperties()

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

Specified by:

getConfigurationProperties in interface org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

getBundles

public List<org.eclipse.equinox.p2.metadata.IVersionedId> getBundles(boolean includeFragments)

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

Specified by:

getBundles in interface org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

Parameters:

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

getBundleInfos

public List<org.eclipse.equinox.frameworkadmin.BundleInfo> getBundleInfos()

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

Specified by:

getBundleInfos in interface org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

Returns:

A List

getFragments

public List<org.eclipse.equinox.p2.metadata.IVersionedId> getFragments()

Returns a list of fragments that constitute this product.

Specified by:

getFragments in interface org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

getFeatures

public List<org.eclipse.equinox.p2.metadata.IVersionedId> getFeatures()

Returns a List of features that constitute this product.

Specified by:

getFeatures in interface org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

getIcons

public String[] getIcons(String os)

Specified by:

getIcons in interface org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

getConfigIniPath

public String getConfigIniPath(String os)

Specified by:

getConfigIniPath in interface org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

getConfigIniPath

public String getConfigIniPath()

getId

public String getId()

Returns the ID for this product.

Specified by:

getId in interface org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

getProductId

public String getProductId()

Specified by:

getProductId in interface org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

getSplashLocation

public String getSplashLocation()

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

Specified by:

getSplashLocation in interface org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

getProductName

public String getProductName()

Returns the product name.

Specified by:

getProductName in interface org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

getApplication

public String getApplication()

Returns the application identifier for this product.

Specified by:

getApplication in interface org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

useFeatures

public boolean useFeatures()

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

Specified by:

useFeatures in interface org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

getVersion

public String getVersion()

Returns the version of the product

Specified by:

getVersion in interface org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

getVMArguments

public String getVMArguments(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 org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

getProgramArguments

public String getProgramArguments(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 org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

getLicenseText

public String getLicenseText()

Specified by:

getLicenseText in interface org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

getLicenseURL

public String getLicenseURL()

Specified by:

getLicenseURL in interface org.eclipse.equinox.internal.p2.publisher.eclipse.IProductDescriptor

startElement

public void startElement(String uri,
                         String localName,
                         String qName,
                         Attributes attributes)

Specified by:

startElement in interface ContentHandler

Overrides:

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

endElement

public void endElement(String uri,
                       String localName,
                       String qName)

Specified by:

endElement in interface 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 ContentHandler

Overrides:

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

processPlugin

protected void processPlugin(Attributes attributes)