org.codehaus.mojo.aspectj
Class AjcReportMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.reporting.AbstractMavenReport
          extended by org.codehaus.mojo.aspectj.AjcReportMojo
All Implemented Interfaces:
ContextEnabled, Mojo, MavenReport

public class AjcReportMojo
extends AbstractMavenReport

Creates a ajdoc report in html format. requiresDependencyResolution compile

Author:
Kaare Nilsen
Is defined by the goal name:
aspectj-report

Field Summary
protected  String complianceLevel
          Specify compiler compliance setting (1.3 to 1.6, default is 1.4)
protected  String doctitle
          Specifies the title to be placed near the top of the overview summary file.
protected  String overview
          Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
protected  boolean packageScope
          Shows only package, protected, and public classes and members.
protected  boolean privateScope
          Shows all classes and members.
protected  boolean protectedScope
          Shows only protected and public classes and members.
protected  boolean publicScope
          Shows only public classes and members.
protected  boolean verbose
          Provides more detailed messages while javadoc is running.
 
Fields inherited from interface org.apache.maven.reporting.MavenReport
CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
AjcReportMojo()
           
 
Method Summary
 boolean canGenerateReport()
           
protected  void executeReport(Locale locale)
          Executes this ajdoc-report generation.
protected  List getClasspathDirectories()
          get compileroutput directory.
 String getDescription(Locale locale)
           
 String getName(Locale locale)
           
protected  String getOutputDirectory()
          get report output directory.
 String getOutputName()
           
protected  MavenProject getProject()
          Get the maven project.
protected  org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
          Get the site renderer.
protected  List getSourceDirectories()
          Get the directories containg sources
 boolean isExternalReport()
           
 void setComplianceLevel(String complianceLevel)
          Setters which when called sets compiler arguments
 void setDoctitle(String doctitle)
           
 void setOverview(String overview)
           
 void setPackageScope(boolean packageScope)
           
 void setPluginArtifacts(List pluginArtifacts)
           
 void setPrivateScope(boolean privateScope)
           
 void setProtectedScope(boolean protectedScope)
           
 void setPublicScope(boolean publicScope)
           
 void setVerbose(boolean verbose)
           
 
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, execute, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, setReportOutputDirectory
 
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

packageScope

protected boolean packageScope
Shows only package, protected, and public classes and members.

Is defined by:

protectedScope

protected boolean protectedScope
Shows only protected and public classes and members. This is the default.

Is defined by:

privateScope

protected boolean privateScope
Shows all classes and members.

Is defined by:

publicScope

protected boolean publicScope
Shows only public classes and members.

Is defined by:

overview

protected String overview
Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html). The path/filename is relative to the ${basedir}. While you can use any name you want for filename and place it anywhere you want for path, a typical thing to do is to name it overview.html and place it in the source tree at the directory that contains the topmost package directories. In this location, no path is needed when documenting packages, since -sourcepath will point to this file. For example, if the source tree for the java.lang package is /src/classes/java/lang/, then you could place the overview file at /src/classes/overview.html. See Real World Example. For information about the file specified by path/filename, see overview comment file.Note that the overview page is created only if you pass into javadoc two or more package names. For further explanation, see HTML Frames.) The title on the overview page is set by -doctitle.

Is defined by:

doctitle

protected String doctitle
Specifies the title to be placed near the top of the overview summary file. The title will be placed as a centered, level-one heading directly beneath the upper navigation bar. The title may contain html tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within title may have to be escaped.

Is defined by:

verbose

protected boolean verbose
Provides more detailed messages while javadoc is running. Without the verbose option, messages appear for loading the source files, generating the documentation (one message per source file), and sorting. The verbose option causes the printing of additional messages specifying the number of milliseconds to parse each java source file.

Is defined by:

complianceLevel

protected String complianceLevel
Specify compiler compliance setting (1.3 to 1.6, default is 1.4)

Is defined by:
default-value:
${mojo.java.target}
Constructor Detail

AjcReportMojo

public AjcReportMojo()
Method Detail

executeReport

protected void executeReport(Locale locale)
                      throws MavenReportException
Executes this ajdoc-report generation.

Specified by:
executeReport in class AbstractMavenReport
Throws:
MavenReportException

getSourceDirectories

protected List getSourceDirectories()
Get the directories containg sources


getOutputDirectory

protected String getOutputDirectory()
get report output directory.

Specified by:
getOutputDirectory in class AbstractMavenReport

getClasspathDirectories

protected List getClasspathDirectories()
get compileroutput directory.


getOutputName

public String getOutputName()

getName

public String getName(Locale locale)

getDescription

public String getDescription(Locale locale)

isExternalReport

public boolean isExternalReport()
Specified by:
isExternalReport in interface MavenReport
Overrides:
isExternalReport in class AbstractMavenReport
See Also:
AbstractMavenReport.isExternalReport()

canGenerateReport

public boolean canGenerateReport()
Specified by:
canGenerateReport in interface MavenReport
Overrides:
canGenerateReport in class AbstractMavenReport
See Also:
AbstractMavenReport.canGenerateReport()

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
Get the site renderer.

Specified by:
getSiteRenderer in class AbstractMavenReport

getProject

protected MavenProject getProject()
Get the maven project.

Specified by:
getProject in class AbstractMavenReport

setOverview

public void setOverview(String overview)

setDoctitle

public void setDoctitle(String doctitle)

setPackageScope

public void setPackageScope(boolean packageScope)

setPrivateScope

public void setPrivateScope(boolean privateScope)

setProtectedScope

public void setProtectedScope(boolean protectedScope)

setPublicScope

public void setPublicScope(boolean publicScope)

setVerbose

public void setVerbose(boolean verbose)

setComplianceLevel

public void setComplianceLevel(String complianceLevel)
Setters which when called sets compiler arguments


setPluginArtifacts

public void setPluginArtifacts(List pluginArtifacts)


Copyright © 2005-2012 Codehaus. All Rights Reserved.