de.smartics.maven.exceptions.sdoccode
Class CopySdocCodeMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      de.smartics.maven.exceptions.sdoccode.AbstractSdocCodeMojo
          de.smartics.maven.exceptions.sdoccode.CopySdocCodeMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class CopySdocCodeMojo
     
     

      
      extends 
      
      AbstractSdocCodeMojo
     
     

Extracts the exception code information of a project and generates one XML document for each code in the projectdoc's appcode doctype format.

Author:

Robert Reiner

maven-goal:

copy

maven-phase:

process-classes

maven-requiresProject:

maven-description:

XML export of project error codes.

Field Summary

protected File

genSrcDir The directory containing the generated documentation XML files.

Fields inherited from class de.smartics.maven.exceptions.sdoccode.AbstractSdocCodeMojo

locale, output, pluginArtifacts, project, skip

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

CopySdocCodeMojo()

Method Summary

protected void

handleGeneratedDocuments() Handles the generated documents.

Methods inherited from class de.smartics.maven.exceptions.sdoccode.AbstractSdocCodeMojo

execute, getProject, setProject

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

genSrcDir

protected File genSrcDir

The directory containing the generated documentation XML files.

Since:

1.0

maven-parameter:

expression="${project.build.directory}/projectdoc-work/generated/process/implementation/appproperty"

maven-required:

Constructor Detail

CopySdocCodeMojo

public CopySdocCodeMojo()

Method Detail

handleGeneratedDocuments

protected void handleGeneratedDocuments()
                                 throws org.apache.maven.plugin.MojoExecutionException,
                                        org.apache.maven.plugin.MojoFailureException

Handles the generated documents.

Specified by:

handleGeneratedDocuments in class AbstractSdocCodeMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - if the execution encounters a problem.

org.apache.maven.plugin.MojoFailureException - if the mojo fails.