org.sonar.api.batch.maven
Interface MavenPluginHandler

All Superinterfaces:
BatchComponent, BatchExtension, Extension

public interface MavenPluginHandler
extends BatchExtension

Since:
1.10

Method Summary
 void configure(Project project, MavenPlugin plugin)
          Configures the pom being executed, add or remove plugin properties.
 String getArtifactId()
          The plugin artifact id
 String[] getGoals()
          The maven goals to execute
 String getGroupId()
          The plugin group id
 String getVersion()
          The fixed plugin version to execute
 boolean isFixedVersion()
          Indicates if the plugin version should be fixed or not, it means that if your pom defines another version than the one defined by getVersion(), this version will be used
 

Method Detail

getGroupId

@Nonnull
String getGroupId()
The plugin group id

Returns:
the group id

getArtifactId

@Nonnull
String getArtifactId()
The plugin artifact id

Returns:
artifact id

getVersion

@Nullable
String getVersion()
The fixed plugin version to execute

Returns:
the plugin version

isFixedVersion

boolean isFixedVersion()
Indicates if the plugin version should be fixed or not, it means that if your pom defines another version than the one defined by getVersion(), this version will be used

Returns:
true if the version should be fixed

getGoals

@Nonnull
String[] getGoals()
The maven goals to execute

Returns:
an array of goals

configure

void configure(Project project,
               MavenPlugin plugin)
Configures the pom being executed, add or remove plugin properties. This method is automatically executed by Sonar. Plugins do NOT have to execute it.



Copyright © 2009-2014 SonarSource. All Rights Reserved.