de.smartics.maven.apidoc
Class JavadocPluginConfigurationExtractor

java.lang.Object
  de.smartics.maven.apidoc.JavadocPluginConfigurationExtractor

public class JavadocPluginConfigurationExtractor
     
     

      
      extends 
      
      Object
     
     

Helper to add additional parameters provided by the maven-javadoc-plugin to be passed to the Javadoc tool.

Author:

Robert Reiner

Field Summary

protected static String

ID_PREFIX_OF_RELEVANT_ELEMENT The prefix of the id attribute of an additionalParam element to be relevant for the extractor.

Constructor Summary

JavadocPluginConfigurationExtractor()
Default constructor.

Method Summary

void	addJavadocPluginArguments(MavenProject project, String reportSetId, Map<String,String> javadocArguments) Adds additional parameters found in the configuration of the maven-javadoc-plugin to the given javadocArguments.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID_PREFIX_OF_RELEVANT_ELEMENT

protected static final String ID_PREFIX_OF_RELEVANT_ELEMENT

The prefix of the id attribute of an additionalParam element to be relevant for the extractor.

The value of this constant is "apidoc".

Constant Field Value:

"apidoc"

Constructor Detail

JavadocPluginConfigurationExtractor

public JavadocPluginConfigurationExtractor()

Default constructor.

Method Detail

addJavadocPluginArguments

public void addJavadocPluginArguments(MavenProject project,
                                      String reportSetId,
                                      Map<String,String> javadocArguments)

Adds additional parameters found in the configuration of the maven-javadoc-plugin to the given javadocArguments.

Parameters:

project - the reference to the maven project to look for the configuration of the maven-javadoc-plugin.

reportSetId - the identifier of the report set to watch for configurations.

javadocArguments - the arguments to add to.