Field Detail

• public java.lang.String arch

  Used to set optional property `arch` for feature XML file

• public FeaturePropertyExtension copyright

  The object is used by copyright method to configure the configure the closure and later extract information from them regarding copyright

• public FeaturePropertyExtension description

  The object is used by description method to configure the configure the closure and later extract information from them regarding description

• public org.w3c.dom.Document doc

  The Below properties are used during the XML file creation

• public org.w3c.dom.Element featureRootElement

• public java.lang.String id

  Used to configure the id of feature

• public java.util.List<FeatureIncludesProperty> includes

  This List is used to store all the Features that the user wants to include

• public java.lang.String label

  Used to write short descriptive label inside the XML file

• public FeaturePropertyExtension license

  The object is used by license method to configure the configure the closure and later extract information from them regarding license

• public java.lang.String nl

  Used to set optional property `nl` for feature XML file

• public java.lang.String os

  Used to set optional property `os` for feature XML file

• public java.util.List<FeaturePluginProperty> plugins

  This List is used to store all the Pluginss that the user wants to include

• public java.lang.String providerName

  Used to configure the providerName of feature

• public java.lang.String version

  Used to configure the version of feature archive

• public java.lang.String ws

  Used to set optional property `ws` for feature XML file

Property Detail

• java.lang.String arch

• java.lang.String id

• java.lang.String label

• java.lang.String nl

• java.lang.String os

• java.lang.String providerName

• java.lang.String version

• java.lang.String ws

Constructor Detail

• FeatureExtension(org.gradle.api.Task task)

  The constructor does few things 1) Initializes all the String member used for property setting to "" 2) Creates all the required instance of {

  Link:

  FeaturePropertyExtension} 3) Initializes Both the lists user for storing information 4) Creates the Document object and Root elemnt for the XML file to be created 5) Add another extension named `require` to the task object 6)Creates `build`, `build/libs` and `build/features` directory (creating directory was necessary or else it was giving error in some case) and `build/features/feature.xml`.

  Parameters:

  task - this object is stored into a private member for further usage

Method Detail

• void copyright(@groovy.lang.DelegatesTo(FeaturePropertyExtension) groovy.lang.Closure configurator)

  This method is used to set all the copyright related information within the feature. It uses the copyright object created within the constructor to extract the information from Closure passed.

  Parameters:

  configurator - the closure is used to create a DSL and latter extract information from it within the function

• void createFeatureArchive()

  This function simply calls two functions 1) writeFile() :- to write the `feature.xml` file itself 2) writeManifestFile :- this method from {

  Link:

  FeatureRequirePropertyExtension} is used to write manifest file inside the archives

• void description(@groovy.lang.DelegatesTo(FeaturePropertyExtension) groovy.lang.Closure configurator)

  This method is used to set all the description related information within the feature. It uses the description object created within the constructor to extract the information from Closure passed.

  Parameters:

  configurator - the closure is used to create a DSL and latter extract information from it within the function

• @org.gradle.api.tasks.Input @java.util.Optional java.lang.String getArch()

• @org.gradle.api.tasks.Input @java.util.Optional java.lang.String getId()

• @org.gradle.api.tasks.Input @java.util.Optional java.lang.String getLabel()

• @org.gradle.api.tasks.Input @java.util.Optional java.lang.String getNl()

• @org.gradle.api.tasks.Input @java.util.Optional java.lang.String getOs()

• @org.gradle.api.tasks.Input @java.util.Optional java.lang.String getProviderName()

• @org.gradle.api.tasks.Input @java.util.Optional java.lang.String getVersion()

• @org.gradle.api.tasks.Input @java.util.Optional java.lang.String getWs()

• void includes(java.lang.String id, java.lang.String version, groovy.lang.Closure configurator)

  This methods takes three parameter namely id,version and a Closure which is used to create a object of Class FeatureIncludesProperty and the created object is then added to list named includes. IN order to resolve the passed Closure an object of class FeatureIncludesProperty(it is a private inner class)

  Parameters:

  id - id of the feature to be included

  version - version of the feature to be included

  configurator - used to pass all the optional information regarding the required feature

• void license(@groovy.lang.DelegatesTo(FeaturePropertyExtension) groovy.lang.Closure configurator)

  This method is used to set all the license related information within the feature. It uses the license object created within the constructor to extract the information from Closure passed.

  Parameters:

  configurator - the closure is used to create a DSL and latter extract information from it within the function

• void plugin(java.lang.String id, java.lang.String version, groovy.lang.Closure configurator)

  This methods takes three parameter namely id,version and a Closure which is used to create a object of Class FeaturePluginProperty and the created object is then added to list named plugins. In order to resolve the passed Closure an object of class FeaturePluginProperty(it is a private inner class)

  Parameters:

  id - id of the plugin to be included

  version - version of the plugin to be included

  configurator - used to pass all the optional information regarding the required plugin

• void setArch(java.lang.String arch)

• void setId(java.lang.String id)

• void setLabel(java.lang.String label)

• void setNl(java.lang.String nl)

• void setOs(java.lang.String os)

• void setProviderName(java.lang.String providerName)

• void setVersion(java.lang.String version)

• void setWs(java.lang.String ws)

• void writeFile()

  This function simply writes creates a element , adds attributes to them and then adds the created element to Root Element of the XML file. Before creating the element or attribute, it first checks if it s set by the user, thereby does not create unncessary elements and attributes in XML file