Maven Usage

Javadocs

Tags were placed in the pom file for the parent module to set the quiet and linksource parameters to true.

Maven Dependencies

When creating the project, I ran into some problems because of the dependencies in the Maven pom files. Look at the POM file in the parent module to see how this was resolved.

• Version 2.10.3 of maven-javadoc-plugin has a dependency on version 2.2.1 of maven-core, which in turn has dependencies on slf4j-nop and slf4j-jdk14. This caused problems when using the tutorials-common jar file in multiple environments. A dependency on version 3.3.9 of maven-core was placed in the parent module. Since version 3.3.9 didn't have these undesired dependencies, that solved the problem.
• Version 2.10.3 of maven-javadoc-plugin also has a dependency on the log4j artifact, causing another problem when dealing with multiple logging frameworks. The dependency tag for maven-javadoc-plugin in the tutorials-common module was modified to exclude the logj4 artifact.
• The page http://stackoverflow.com/questions/11758676/resolve-multiple-slf4j-bindings-in-maven-project contains some information on resolving the conflicts.

Maven Goals

The following Maven goals are used with this project.

• clean -- This removes files generated by previous Maven tasks.
• compile -- This compiles all of the Java code found in the module.
• javadoc:javadoc -- This generates the Javadocs for the module and places them in the site/apidocs directory. See http://maven.apache.org/plugins/maven-javadoc-plugin/.
• dependency Tools for analyzing and processing the dependencies of a Maven project. See http://maven.apache.org/plugins/maven-dependency-plugin/usage.html.
  • dependency:copy-dependencies -- This places the jar files that represent the dependencies for the module in the site direcory.
  • dependency:tree List the dependencies for the module.
  • dependency:purge-local-repository
• install - This plugin installs artifacts n the local Maven repository. See http://maven.apache.org/plugins/maven-install-plugin/.
  • install:install This will install the artifact in your local Maven repository so that it can be used by other Maven projects.
  • install:install-file This will create an artifact from a jar or war file that was not created using Maven and install it in your local Maven repository so that it can be used by other Maven projects.
• package -- This creates the jar or war file that is the final product of the module.