de.smartics.analysis.javadoc
Class JavadocArgumentsUtils

java.lang.Object
  de.smartics.analysis.javadoc.JavadocArgumentsUtils

public final class JavadocArgumentsUtils
     
     

      
      extends 
      
      Object
     
     

Utility class to map information from a project configuration to a map of arguments that can be passed to the Javadoc tool.

Author:

Robert Reiner

Method Summary

static Map<String,String>	addJavadocArguments(JavadocProjectConfiguration configuration, Map<String,String> javadocArguments) Maps the information from the configuration to the map of arguments that is passed to the Javadoc tool.
static Map<String,String>	addJavadocArguments(Log log, JavadocProjectConfiguration configuration, Map<String,String> javadocArguments) Maps the information from the configuration to the map of arguments that is passed to the Javadoc tool.
static Map<String,String>	createJavadocArguments(JavadocProjectConfiguration configuration) Maps the information from the configuration to the map of arguments that is passed to the Javadoc tool.
static Map<String,String>	createJavadocArguments(Log log, JavadocProjectConfiguration configuration) Maps the information from the configuration to the map of arguments that is passed to the Javadoc tool.

Methods inherited from class java.lang.Object

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

Method Detail

createJavadocArguments

public static Map<String,String> createJavadocArguments(JavadocProjectConfiguration configuration)
                                                 throws NullPointerException

Maps the information from the configuration to the map of arguments that is passed to the Javadoc tool.

Parameters:

configuration - the information bundle to fetch from.

Returns:

the arguments map for the Javadoc too.

Throws:

NullPointerException - if the configuration is null.

createJavadocArguments

public static Map<String,String> createJavadocArguments(Log log,
                                                        JavadocProjectConfiguration configuration)

Maps the information from the configuration to the map of arguments that is passed to the Javadoc tool.

Parameters:

log - the logger to use.

configuration - the information bundle to fetch from.

Returns:

the arguments map for the Javadoc too.

addJavadocArguments

public static Map<String,String> addJavadocArguments(JavadocProjectConfiguration configuration,
                                                     Map<String,String> javadocArguments)

Maps the information from the configuration to the map of arguments that is passed to the Javadoc tool.

Parameters:

configuration - the information bundle to fetch from.

javadocArguments - the arguments to add to.

Returns:

the arguments map for the Javadoc too.

addJavadocArguments

public static Map<String,String> addJavadocArguments(Log log,
                                                     JavadocProjectConfiguration configuration,
                                                     Map<String,String> javadocArguments)

Maps the information from the configuration to the map of arguments that is passed to the Javadoc tool.

Parameters:

log - the logger to use.

configuration - the information bundle to fetch from.

javadocArguments - the arguments to add to.

Returns:

the arguments map for the Javadoc too.