IProductDescriptor

All Known Implementing Classes:

ProductFile
```
public interface IProductDescriptor
```
Represents a product file. If getLocation returns null, then config.ini and p2 advice files cannot be used (since these are both relative to the product location).

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`INCLUDED_FEATURES` Flag for `getFeatures(int)` to obtain the features included in the product.
`static int`	`ROOT_FEATURES` Flag for `getFeatures(int)` to obtain the features to be installed as separately updatable roots.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getApplication()` Returns the Applicaiton extension point ID
`java.util.List<BundleInfo>`	`getBundleInfos()` Returns a List for each bundle that has custom configuration data.
`java.util.List<IVersionedId>`	`getBundles(boolean includeFragments)` Returns the bundles listed in this product.
`java.lang.String`	`getConfigIniPath(java.lang.String os)` Returns the path to the config.ini file as specified in the .product file.
`java.util.Map<java.lang.String,java.lang.String>`	`getConfigurationProperties()` Returns the properties for a product file.
`java.util.Map<java.lang.String,java.lang.String>`	`getConfigurationProperties(java.lang.String os, java.lang.String arch)` Returns the properties for this product file for a given OS and architecture combination.
`java.util.List<IVersionedId>`	`getFeatures()` Returns the features listed in the product.
`java.util.List<IVersionedId>`	`getFeatures(int options)` Returns the features listed in the product.
`java.util.List<IVersionedId>`	`getFragments()` Returns the fragments listed in the product.
`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.
`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()` This is needed for config.ini files and p2 advice
`ProductContentType`	`getProductContentType()` Specifies what kind of installable units (e.g. bundles, features or everything) are included in the product.
`java.lang.String`	`getProductId()` Returns the Product extension point ID
`java.lang.String`	`getProductName()` Returns the name of the product
`java.lang.String`	`getProgramArguments(java.lang.String os)` Returns the program arguments for this product for a given OS.
`java.lang.String`	`getProgramArguments(java.lang.String os, java.lang.String arch)` Returns the program arguments for this product for a given OS and architecture combination.
`java.util.List<IRepositoryReference>`	`getRepositoryEntries()` Returns a List for each update repository used by the product.
`java.lang.String`	`getSplashLocation()` Returns the ID of the bundle in which the splash screen resides.
`java.lang.String`	`getVersion()` Returns the version of the product.
`java.lang.String`	`getVMArguments(java.lang.String os)` Returns the VM arguments for this product for a given OS.
`java.lang.String`	`getVMArguments(java.lang.String os, java.lang.String arch)` Returns the VM arguments for this product for a given OS 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`	`includeLaunchers()` Determines if the launchers should be included in the published product
`boolean`	`useFeatures()` Specifies whether this product was built using features only or not.

- Field Detail
  - INCLUDED_FEATURES
```
static final int INCLUDED_FEATURES
```
    Flag for getFeatures(int) to obtain the features included in the product.
    
    See Also:
    
    Constant Field Values
  - ROOT_FEATURES
```
static final int ROOT_FEATURES
```
    Flag for getFeatures(int) to obtain the features to be installed as separately updatable roots.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getLauncherName
```
java.lang.String getLauncherName()
```
    Gets the name of the launcher.
  - getBundles
```
java.util.List<IVersionedId> getBundles(boolean includeFragments)
```
    Returns the bundles listed in this product. Note: These bundles are only part of the product if useFeatures() returns false.
    
    Parameters:
    
    includeFragments - whether or not to include the fragments in the return value
    
    Returns:
    
    the list of bundles in this product.
  - hasBundles
```
boolean hasBundles(boolean includeFragments)
```
    Returns true when getBundles(includeFragments) returns a non-empty list.
  - getFragments
```
java.util.List<IVersionedId> getFragments()
```
    Returns the fragments listed in the product.
    
    See Also:
    
    useFeatures()
  - getFeatures
```
java.util.List<IVersionedId> getFeatures()
```
    Returns the features listed in the product. Same as getFeatures(INCLUDED_FEATURES). Note: These features are only part of the product if useFeatures() returns true.
  - hasFeatures
```
boolean hasFeatures()
```
    Returns true when getFeatures() returns a non-empty list.
  - getFeatures
```
java.util.List<IVersionedId> getFeatures(int options)
```
    Returns the features listed in the product. Note: These features are only part of the product if useFeatures() returns true.
    
    Parameters:
    
    options - bitmask to indicate what kind of features to return.
    
    See Also:
    
    INCLUDED_FEATURES, ROOT_FEATURES
  - getConfigIniPath
```
java.lang.String getConfigIniPath(java.lang.String os)
```
    Returns the path to the config.ini file as specified in the .product file.
  - getId
```
java.lang.String getId()
```
    Returns the ID for this product.
  - getProductId
```
java.lang.String getProductId()
```
    Returns the Product extension point ID
  - getApplication
```
java.lang.String getApplication()
```
    Returns the Applicaiton extension point ID
  - getSplashLocation
```
java.lang.String getSplashLocation()
```
    Returns the ID of the bundle in which the splash screen resides.
  - getProductName
```
java.lang.String getProductName()
```
    Returns the name of the product
  - useFeatures
```
boolean useFeatures()
```
    Specifies whether this product was built using features only or not.
  - getProductContentType
```
ProductContentType getProductContentType()
```
    Specifies what kind of installable units (e.g. bundles, features or everything) are included in the product.
  - getVersion
```
java.lang.String getVersion()
```
    Returns the version of the product.
  - getVMArguments
```
java.lang.String getVMArguments(java.lang.String os)
```
    Returns the VM arguments for this product for a given OS.
  - getVMArguments
```
java.lang.String getVMArguments(java.lang.String os,
                                java.lang.String arch)
```
    Returns the VM arguments for this product for a given OS and architecture combination.
  - getProgramArguments
```
java.lang.String getProgramArguments(java.lang.String os)
```
    Returns the program arguments for this product for a given OS.
  - getProgramArguments
```
java.lang.String getProgramArguments(java.lang.String os,
                                     java.lang.String arch)
```
    Returns the program arguments for this product for a given OS and architecture combination.
  - getConfigurationProperties
```
java.util.Map<java.lang.String,java.lang.String> getConfigurationProperties()
```
    Returns the properties for a product file.
  - getConfigurationProperties
```
java.util.Map<java.lang.String,java.lang.String> getConfigurationProperties(java.lang.String os,
                                                                            java.lang.String arch)
```
    Returns the properties for this product file for a given OS and architecture combination. If the os and/or arch are not specified, then only those properties defined without os and/or arch filtering will be returned.
  - getIcons
```
java.lang.String[] getIcons(java.lang.String os)
```
    Returns a list of icons for this product for a given OS.
  - getBundleInfos
```
java.util.List<BundleInfo> getBundleInfos()
```
    Returns a List for each bundle that has custom configuration data.
    
    Returns:
    
    A List
  - getLocation
```
java.io.File getLocation()
```
    This is needed for config.ini files and p2 advice
  - includeLaunchers
```
boolean includeLaunchers()
```
    Determines if the launchers should be included in the published product
  - getLicenseURL
```
java.lang.String getLicenseURL()
```
    Returns the license URL for this product
  - getLicenseText
```
java.lang.String getLicenseText()
```
    Returns the license text for this product
  - getRepositoryEntries
```
java.util.List<IRepositoryReference> getRepositoryEntries()
```
    Returns a List for each update repository used by the product.
    
    Returns:
    
    A List

Interface IProductDescriptor

Field Summary

Method Summary

Field Detail

INCLUDED_FEATURES

ROOT_FEATURES

Method Detail

getLauncherName

getBundles

hasBundles

getFragments

getFeatures

hasFeatures

getFeatures

getConfigIniPath

getId

getProductId

getApplication

getSplashLocation

getProductName

useFeatures

getProductContentType

getVersion

getVMArguments

getVMArguments

getProgramArguments

getProgramArguments

getConfigurationProperties

getConfigurationProperties

getIcons

getBundleInfos

getLocation

includeLaunchers

getLicenseURL

getLicenseText

getRepositoryEntries