Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD DETAIL: FIELD | PROPERTY | CONSTR | METHOD

org.standardout.gradle.plugin.platform
[Groovy] Class PlatformPluginExtension

java.lang.Object
  org.standardout.gradle.plugin.platform.PlatformPluginExtension

class PlatformPluginExtension

Extension for the platform plugin.

Authors:
Simon Templer

Property Summary
java.util.Map artifacts

Maps artifact IDs to BundleArtifacts
java.lang.String categoryId

The ID of the feature's category in the update site.
java.lang.String categoryName

The name of the feature's category in the update site.
Configurations configurations

Stores bnd configurations.
java.io.File eclipseHome

The directory of a local Eclipse installation.

java.lang.Object eclipseMirror

Nested map that is checked for Eclipse download URLs, keys are osgiOS (win32, linux, macosx), osgiWS (win32, gtk, cocoa) and arch (x86, x86_64) in that order.

java.lang.String featureId

The ID for the platform feature.
java.lang.String featureName

The name for the platform feature.
java.lang.String featureVersion

The platform feature version, defaults to the project version if possible, otherwise to 1.0.0.
boolean fetchSources

States if source for external dependencies should be fetched and corresponding source bundles created.
Project project

java.io.File updateSiteDir

The directory to place the update site in.

java.io.File updateSiteZipFile

The target file for the 'updateSiteZip' task.
 
Constructor Summary
PlatformPluginExtension(Project project)

 
Method Summary
java.lang.Object bnd(java.lang.Object dependencyNotation, groovy.lang.Closure bndClosure)

Call bnd to configure artifact, but don't add as dependency.
java.lang.Object bnd(groovy.lang.Closure bndClosure)

Call bnd to extend/overwrite the default bnd configuration for all bundles.

java.lang.Object bundle(java.lang.Object dependencyNotation, groovy.lang.Closure configClosure = null)

Call bundle to add a dependency.
java.lang.Object merge(java.util.Map properties = [failOnDuplicate: true, groovy.lang.Closure mergeClosure)

Call merge to create bundle that is merged from different dependencies.
 
Methods inherited from class java.lang.Object
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Property Detail

artifacts

final java.util.Map artifacts
Maps artifact IDs to BundleArtifacts

categoryId

java.lang.String categoryId
The ID of the feature's category in the update site.

categoryName

java.lang.String categoryName
The name of the feature's category in the update site.

configurations

final Configurations configurations
Stores bnd configurations.

eclipseHome

java.io.File eclipseHome
The directory of a local Eclipse installation. If none is specified the ECLIPSE_HOME system property is checked, if it is not given as well it is tried to download Eclipse based on the URLs defined in eclipseMirror

eclipseMirror

java.lang.Object eclipseMirror
Nested map that is checked for Eclipse download URLs, keys are osgiOS (win32, linux, macosx), osgiWS (win32, gtk, cocoa) and arch (x86, x86_64) in that order. Specify an alternate Eclipse mirror like this: eclipseMirror.win32.win32.x86 = 'http://...'

featureId

java.lang.String featureId
The ID for the platform feature.

featureName

java.lang.String featureName
The name for the platform feature.

featureVersion

java.lang.String featureVersion
The platform feature version, defaults to the project version if possible, otherwise to 1.0.0.

fetchSources

boolean fetchSources
States if source for external dependencies should be fetched and corresponding source bundles created.

project

final Project project

updateSiteDir

java.io.File updateSiteDir
The directory to place the update site in. Will default to 'updatesite' in the build folder.

updateSiteZipFile

java.io.File updateSiteZipFile
The target file for the 'updateSiteZip' task.

 
Constructor Detail

PlatformPluginExtension

PlatformPluginExtension(Project project)

 
Method Detail

bnd

java.lang.Object bnd(java.lang.Object dependencyNotation, groovy.lang.Closure bndClosure)
Call bnd to configure artifact, but don't add as dependency.
Parameters:
dependencyNotation - a dependency notation as supported by Gradle
bndClosure - a closure that specifying the custom bnd configuration
Returns:

bnd

java.lang.Object bnd(groovy.lang.Closure bndClosure)
Call bnd to extend/overwrite the default bnd configuration for all bundles. Note that the default configuration does not apply to Jars that already were bundles.

bundle

java.lang.Object bundle(java.lang.Object dependencyNotation, groovy.lang.Closure configClosure = null)
Call bundle to add a dependency.
Parameters:
dependencyNotation - a dependency notation as supported by Gradle
configClosure - a closure that performs dependency configuration
Returns:

merge

java.lang.Object merge(java.util.Map properties = [failOnDuplicate: true, groovy.lang.Closure mergeClosure)
Call merge to create bundle that is merged from different dependencies.
Parameters:
mergeClosure - the merge closure, specifying a match and bnd configuration
Returns:

 

Groovy Documentation