ContributionManifest (fabric3-spi 3.0.0 API)

java.lang.Object
- org.fabric3.spi.contribution.ContributionManifest

All Implemented Interfaces:

java.io.Serializable
```
public class ContributionManifest
extends java.lang.Object
implements java.io.Serializable
```
A contribution manifest.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ContributionManifest()

Constructors
Constructor and Description
`ContributionManifest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDeployable(org.fabric3.api.host.contribution.Deployable deployable)` Adds a contribution deployable.
`void`	`addExport(Export export)` Adds a contribution export.
`void`	`addExtend(java.lang.String name)` Adds the name of an extension point this contribution extends.
`void`	`addExtensionPoint(java.lang.String name)` Adds an extension point provided by this contribution.
`void`	`addImport(Import imprt)` Adds a contribution import.
`void`	`addLibrary(Library library)` Adds a native code library configuration.
`void`	`addProvidedCapability(Capability capability)` Adds a capability provided by this contribution.
`void`	`addRequiredCapability(Capability capability)` Adds a capability required by the contribution.
`int`	`getBootLevel()` Returns the boot level of the manifest for extensions.
`java.lang.String`	`getContext()` Returns the contribution context path.
`java.util.List<org.fabric3.api.host.contribution.Deployable>`	`getDeployables()` Returns the contribution deployables.
`java.lang.String`	`getDescription()` Returns the contribution description.
`java.util.List<Export>`	`getExports()` Returns the contribution exports.
`java.util.List<java.lang.String>`	`getExtends()` Returns the extension points this contribution extends.
`java.util.List<java.lang.String>`	`getExtensionPoints()` Returns the list of extension points provided by this contribution.
`java.util.List<Import>`	`getImports()` Returns the contribution imports.
`java.util.List<Library>`	`getLibraries()` Returns native code libraries contained in the contribution.
`java.util.Set<Capability>`	`getProvidedCapabilities()` Returns a list of capabilities provided by this contribution.
`java.util.Set<Capability>`	`getRequiredCapabilities()` Returns a list of capabilities required by this contribution.
`java.util.List<java.util.regex.Pattern>`	`getScanExcludes()` Returns file and directory patterns to exclude when the contribution is scanned.
`boolean`	`isExtension()` Returns true if the contribution is an extension.
`void`	`setBootLevel(int bootLevel)` Sets the extension contribution boot level.
`void`	`setContext(java.lang.String context)` Sets the contribution context path.
`void`	`setDescription(java.lang.String description)` Sets the contribution description
`void`	`setExtension(boolean extension)` Sets if the contribution is an extension.
`void`	`setScanExcludes(java.util.List<java.util.regex.Pattern> excludes)` Sets file and directory patterns to exclude when the contribution is scanned.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ContributionManifest
```
public ContributionManifest()
```
- Method Detail
  - getDescription
```
public java.lang.String getDescription()
```
    Returns the contribution description.
    
    Returns:
    
    the contribution description
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Sets the contribution description
    
    Parameters:
    
    description - the contribution description
  - isExtension
```
public boolean isExtension()
```
    Returns true if the contribution is an extension.
    
    Returns:
    
    true if the contribution is an extension
  - setExtension
```
public void setExtension(boolean extension)
```
    Sets if the contribution is an extension.
    
    Parameters:
    
    extension - true if the contribution is an extension
  - getBootLevel
```
public int getBootLevel()
```
    Returns the boot level of the manifest for extensions. If the level is greater than -1, the contribution extension will be loaded as a boot extension in ascending order.
    
    Returns:
    
    the boot level
  - setBootLevel
```
public void setBootLevel(int bootLevel)
```
    Sets the extension contribution boot level.
    
    Parameters:
    
    bootLevel - the level; -1 indicates the extension is not a boot contribution
  - getContext
```
public java.lang.String getContext()
```
    Returns the contribution context path.
    
    Returns:
    
    the contribution context path
  - setContext
```
public void setContext(java.lang.String context)
```
    Sets the contribution context path.
    
    Parameters:
    
    context - the contribution context path
  - getExports
```
public java.util.List<Export> getExports()
```
    Returns the contribution exports.
    
    Returns:
    
    the contribution exports
  - addExport
```
public void addExport(Export export)
```
    Adds a contribution export.
    
    Parameters:
    
    export - the contribution export
  - getImports
```
public java.util.List<Import> getImports()
```
    Returns the contribution imports.
    
    Returns:
    
    the contribution imports
  - addImport
```
public void addImport(Import imprt)
```
    Adds a contribution import.
    
    Parameters:
    
    imprt - the contribution import
  - getLibraries
```
public java.util.List<Library> getLibraries()
```
    Returns native code libraries contained in the contribution.
    
    Returns:
    
    native code libraries contained in the contribution
  - addLibrary
```
public void addLibrary(Library library)
```
    Adds a native code library configuration.
    
    Parameters:
    
    library - the native code library configuration
  - addRequiredCapability
```
public void addRequiredCapability(Capability capability)
```
    Adds a capability required by the contribution.
    
    Parameters:
    
    capability - a capability required by the contribution
  - getRequiredCapabilities
```
public java.util.Set<Capability> getRequiredCapabilities()
```
    Returns a list of capabilities required by this contribution.
    
    Returns:
    
    a list of capabilities required by this contribution
  - addProvidedCapability
```
public void addProvidedCapability(Capability capability)
```
    Adds a capability provided by this contribution.
    
    Parameters:
    
    capability - a capability provided by this contribution
  - getProvidedCapabilities
```
public java.util.Set<Capability> getProvidedCapabilities()
```
    Returns a list of capabilities provided by this contribution.
    
    Returns:
    
    a list of capabilities provided by this contribution
  - getExtensionPoints
```
public java.util.List<java.lang.String> getExtensionPoints()
```
    Returns the list of extension points provided by this contribution.
    
    Returns:
    
    the list of extension points provided by this contribution
  - addExtensionPoint
```
public void addExtensionPoint(java.lang.String name)
```
    Adds an extension point provided by this contribution.
    
    Parameters:
    
    name - the extension point name
  - getExtends
```
public java.util.List<java.lang.String> getExtends()
```
    Returns the extension points this contribution extends.
    
    Returns:
    
    the extension points this contribution extends
  - addExtend
```
public void addExtend(java.lang.String name)
```
    Adds the name of an extension point this contribution extends.
    
    Parameters:
    
    name - the extension point name
  - getDeployables
```
public java.util.List<org.fabric3.api.host.contribution.Deployable> getDeployables()
```
    Returns the contribution deployables.
    
    Returns:
    
    the contribution deployables
  - addDeployable
```
public void addDeployable(org.fabric3.api.host.contribution.Deployable deployable)
```
    Adds a contribution deployable.
    
    Parameters:
    
    deployable - the contribution deployable
  - getScanExcludes
```
public java.util.List<java.util.regex.Pattern> getScanExcludes()
```
    Returns file and directory patterns to exclude when the contribution is scanned.
    
    Returns:
    
    file and directory patterns to exclude when the contribution is scanned
  - setScanExcludes
```
public void setScanExcludes(java.util.List<java.util.regex.Pattern> excludes)
```
    Sets file and directory patterns to exclude when the contribution is scanned.
    
    Parameters:
    
    excludes - file and directory patterns to exclude when the contribution is scanned

Class ContributionManifest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ContributionManifest

Method Detail

getDescription

setDescription

isExtension

setExtension

getBootLevel

setBootLevel

getContext

setContext

getExports

addExport

getImports

addImport

getLibraries

addLibrary

addRequiredCapability

getRequiredCapabilities

addProvidedCapability

getProvidedCapabilities

getExtensionPoints

addExtensionPoint

getExtends

addExtend

getDeployables

addDeployable

getScanExcludes

setScanExcludes