Maven Plugins Provider Extension Point

org.mevenide.ui.preference

0.2.1

This extension allows Maven plugin provider to add Preferences Page under Maven Preference Node in a strictly declarative way.

<!ELEMENT extension (plugin-provider+)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #REQUIRED

name CDATA #REQUIRED>

<!ELEMENT plugin-provider (description? , (category+))>

<!ATTLIST plugin-provider

name CDATA #REQUIRED

id CDATA #REQUIRED>

aggregates specific properties used in the context of a maven plugin.

name - name of the maven plugin, for instance if installing maven-xdoc-plugin, name should be 'XDoc'. It must match the name of the associated preference page.
id - unique identifier of the maven plugin, for instance if installing maven-xdoc-plugin, name should be 'maven-xdoc-plugin'.

<!ELEMENT description (#CDATA)>

an optional description of the Maven plugin.

<!ELEMENT property EMPTY>

<!ATTLIST property

name CDATA #REQUIRED

default CDATA #IMPLIED

label CDATA #IMPLIED

required (true | false)

description CDATA #REQUIRED>

defines a new specific property used by the maven plugin. No validator can be specified yet, but it is definitively on the TODO list.

name - the name of the specific property used by the plugin.
default - default value for the specific property.
label - Human readable label used in the preference page to refer to this property. if not specified, id will be used.
required - indicates if this specific is a required one.
description - Provides a description of the property.

<!ELEMENT category (property+)>

<!ATTLIST category

name CDATA #REQUIRED>

allows to categorize plugin properties. It is especially useful for plugins that expose quite a number of properties (as does the Maven PDE plugin).

name - Human readable name of the category.

<!-- 
  declare the preference page of type org.mevenide.ui.eclipse.preferences.dynamic.DynamicPreferencePage 
-->
<extension point=
"org.eclipse.ui.preferencePages"
>
  <page category=
"org.mevenide.ui.eclipse.preferences.PluginsRoot"
 
        name=
"PDE Plugin"
  
        class=
"org.mevenide.ui.eclipse.preferences.dynamic.DynamicPreferencePage"
 
        id=
"PDE Plugin "
 />

</extension>       
<!-- 
  declare maven plugin properties. name attribute must match the name attribute of the associated preference page
-->
<extension point=
"org.mevenide.ui.preference"
>
  <plugin-provider id=
"maven-eclipse-plugin-plugin"
 
                   name=
"PDE Plugin"
>
    <description>
%Plugin.Description</description>

    <category name=
"Build"
>
      <property name=
"maven.eclipse.plugin.mode"
 
                label=
"Build Mode"

                default=
"bundle"

                required=
"false"


                description=
"%BuildMode.Description"
/>
      <property name=
"maven.eclipse.plugin.dist.dir"
 
                label=
"Distribution Directory"

                default=
"${maven.build.dir}/eclipse/dist"

                required=
"true"


                description=
"%DistDirectory.Description"
/>
    </category>
  </plugin-provider>
</extension>

Theres no available API for now, so Providers dont have to provide any code for now. In the fututre it will be possible for them to provide validators.

Copyright 2003-2004 Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Maven Plugins Provider Extension Point

Identifier:

Since:

Description:

Configuration Markup:

Examples:

API Information: