Author: vsiveton
Date: Sat Dec 1 05:41:15 2007
New Revision: 600123
URL: http://svn.apache.org/viewvc?rev=600123&view=rev
Log:
o updated javadoc and added some since/version tags
o improved code legibility
o no code change
Modified:
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/AbstractProjectInfoReport.java
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/CimReport.java
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/DependenciesReport.java
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/DependencyConvergenceReport.java
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/IssueTrackingReport.java
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/LicenseReport.java
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/MailingListsReport.java
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/ProjectIndexPageReport.java
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/ProjectSummaryReport.java
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/ScmReport.java
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/TeamListReport.java
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/Dependencies.java
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/DependenciesReportConfiguration.java
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/RepositoryUtils.java
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/renderer/DependenciesRenderer.java
Modified:
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/AbstractProjectInfoReport.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/AbstractProjectInfoReport.java?rev=600123&r1=600122&r2=600123&view=diff
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/AbstractProjectInfoReport.java
(original)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/AbstractProjectInfoReport.java
Sat Dec 1 05:41:15 2007
@@ -54,6 +54,8 @@
* Base class with the things that should be in AbstractMavenReport anyway.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Brett Porter</a>
+ * @version $Id$
+ * @since 2.0
*/
public abstract class AbstractProjectInfoReport
extends AbstractMavenReport
@@ -108,41 +110,11 @@
*/
protected I18N i18n;
- private File getSkinArtifactFile()
- throws MojoExecutionException
- {
- Skin skin = Skin.getDefaultSkin();
-
- String version = skin.getVersion();
- Artifact artifact;
- try
- {
- if ( version == null )
- {
- version = Artifact.RELEASE_VERSION;
- }
- VersionRange versionSpec = VersionRange.createFromVersionSpec(
version );
- artifact = factory.createDependencyArtifact( skin.getGroupId(),
skin.getArtifactId(), versionSpec, "jar",
- null, null );
-
- resolver.resolve( artifact,
project.getRemoteArtifactRepositories(), localRepository );
- }
- catch ( InvalidVersionSpecificationException e )
- {
- throw new MojoExecutionException( "The skin version '" + version +
"' is not valid: " + e.getMessage() );
- }
- catch ( ArtifactResolutionException e )
- {
- throw new MojoExecutionException( "Unable to find skin", e );
- }
- catch ( ArtifactNotFoundException e )
- {
- throw new MojoExecutionException( "The skin does not exist: " +
e.getMessage() );
- }
-
- return artifact.getFile();
- }
+ // ----------------------------------------------------------------------
+ // Public methods
+ // ----------------------------------------------------------------------
+ /** [EMAIL PROTECTED] */
public void execute()
throws MojoExecutionException
{
@@ -194,35 +166,70 @@
}
}
- /**
- * @see org.apache.maven.reporting.MavenReport#getCategoryName()
- */
+ /** [EMAIL PROTECTED] */
public String getCategoryName()
{
return CATEGORY_PROJECT_INFORMATION;
}
- /**
- * @see org.apache.maven.reporting.AbstractMavenReport#getOutputDirectory()
- */
+ // ----------------------------------------------------------------------
+ // Protected methods
+ // ----------------------------------------------------------------------
+
+ /** [EMAIL PROTECTED] */
protected String getOutputDirectory()
{
return outputDirectory.getAbsolutePath();
}
- /**
- * @see org.apache.maven.reporting.AbstractMavenReport#getProject()
- */
+ /** [EMAIL PROTECTED] */
protected MavenProject getProject()
{
return project;
}
- /**
- * @see org.apache.maven.reporting.AbstractMavenReport#getSiteRenderer()
- */
+ /** [EMAIL PROTECTED] */
protected Renderer getSiteRenderer()
{
return siteRenderer;
+ }
+
+ // ----------------------------------------------------------------------
+ // Private methods
+ // ----------------------------------------------------------------------
+
+ private File getSkinArtifactFile()
+ throws MojoExecutionException
+ {
+ Skin skin = Skin.getDefaultSkin();
+
+ String version = skin.getVersion();
+ Artifact artifact;
+ try
+ {
+ if ( version == null )
+ {
+ version = Artifact.RELEASE_VERSION;
+ }
+ VersionRange versionSpec = VersionRange.createFromVersionSpec(
version );
+ artifact = factory.createDependencyArtifact( skin.getGroupId(),
skin.getArtifactId(), versionSpec, "jar",
+ null, null );
+
+ resolver.resolve( artifact,
project.getRemoteArtifactRepositories(), localRepository );
+ }
+ catch ( InvalidVersionSpecificationException e )
+ {
+ throw new MojoExecutionException( "The skin version '" + version +
"' is not valid: " + e.getMessage() );
+ }
+ catch ( ArtifactResolutionException e )
+ {
+ throw new MojoExecutionException( "Unable to find skin", e );
+ }
+ catch ( ArtifactNotFoundException e )
+ {
+ throw new MojoExecutionException( "The skin does not exist: " +
e.getMessage() );
+ }
+
+ return artifact.getFile();
}
}
Modified:
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/CimReport.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/CimReport.java?rev=600123&r1=600122&r2=600123&view=diff
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/CimReport.java
(original)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/CimReport.java
Sat Dec 1 05:41:15 2007
@@ -36,21 +36,29 @@
*
* @author <a href="mailto:[EMAIL PROTECTED]">Vincent Siveton </a>
* @version $Id$
+ * @since 2.0
* @goal cim
*/
public class CimReport
extends AbstractProjectInfoReport
{
+ // ----------------------------------------------------------------------
+ // Public methods
+ // ----------------------------------------------------------------------
+
+ /** [EMAIL PROTECTED] */
public String getName( Locale locale )
{
return i18n.getString( "project-info-report", locale,
"report.cim.name" );
}
+ /** [EMAIL PROTECTED] */
public String getDescription( Locale locale )
{
return i18n.getString( "project-info-report", locale,
"report.cim.description" );
}
+ /** [EMAIL PROTECTED] */
public void executeReport( Locale locale )
{
CimRenderer r = new CimRenderer( getSink(), getProject().getModel(),
i18n, locale );
@@ -58,13 +66,14 @@
r.render();
}
+ /** [EMAIL PROTECTED] */
public String getOutputName()
{
return "integration";
}
// ----------------------------------------------------------------------
- //
+ // Private
// ----------------------------------------------------------------------
private static class CimRenderer
@@ -87,11 +96,13 @@
this.locale = locale;
}
+ /** [EMAIL PROTECTED] */
public String getTitle()
{
return i18n.getString( "project-info-report", locale,
"report.cim.title" );
}
+ /** [EMAIL PROTECTED] */
public void renderBody()
{
CiManagement cim = model.getCiManagement();
Modified:
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/DependenciesReport.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/DependenciesReport.java?rev=600123&r1=600122&r2=600123&view=diff
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/DependenciesReport.java
(original)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/DependenciesReport.java
Sat Dec 1 05:41:15 2007
@@ -41,6 +41,7 @@
* @author <a href="mailto:[EMAIL PROTECTED]">Jason van Zyl </a>
* @author <a href="mailto:[EMAIL PROTECTED]">Vincent Siveton </a>
* @version $Id$
+ * @since 2.0
* @goal dependencies
* @requiresDependencyResolution test
*/
@@ -48,33 +49,46 @@
extends AbstractProjectInfoReport
{
/**
- * Maven Project Builder.
+ * Maven Project Builder component.
*
* @component
*/
private MavenProjectBuilder mavenProjectBuilder;
/**
+ * Artifact metadata source component.
+ *
* @component
*/
protected ArtifactMetadataSource artifactMetadataSource;
/**
+ * Artifact collector component.
+ *
* @component
*/
private ArtifactCollector collector;
/**
+ * Wagon manager component.
+ *
+ * @since 2.1
* @component
*/
private WagonManager wagonManager;
/**
+ * Dependency tree builder component.
+ *
+ * @since 2.1
* @component
*/
private DependencyTreeBuilder dependencyTreeBuilder;
/**
+ * Jar classes analyser component.
+ *
+ * @since 2.1
* @component
*/
private JarClassesAnalysis classesAnalyzer;
@@ -82,6 +96,7 @@
/**
* The current user system settings for use in Maven.
*
+ * @since 2.1
* @parameter expression="${settings}"
* @required
* @readonly
@@ -91,7 +106,8 @@
/**
* Display file details for each dependency, such as: file size, number of
* classes, number of packages etc.
- *
+ *
+ * @since 2.1
* @parameter expression="${dependency.details.enabled}"
default-value="true"
*/
private boolean dependencyDetailsEnabled;
@@ -99,29 +115,28 @@
/**
* Display the repository locations of the dependencies. Requires Maven
2.0.5+.
*
+ * @since 2.1
* @parameter expression="${dependency.locations.enabled}"
default-value="false"
*/
private boolean dependencyLocationsEnabled;
- /**
- * @see org.apache.maven.reporting.MavenReport#getName(java.util.Locale)
- */
+ // ----------------------------------------------------------------------
+ // Public methods
+ // ----------------------------------------------------------------------
+
+ /** [EMAIL PROTECTED] */
public String getName( Locale locale )
{
return i18n.getString( "project-info-report", locale,
"report.dependencies.name" );
}
- /**
- * @see
org.apache.maven.reporting.MavenReport#getDescription(java.util.Locale)
- */
+ /** [EMAIL PROTECTED] */
public String getDescription( Locale locale )
{
return i18n.getString( "project-info-report", locale,
"report.dependencies.description" );
}
- /**
- * @see
org.apache.maven.reporting.AbstractMavenReport#executeReport(java.util.Locale)
- */
+ /** [EMAIL PROTECTED] */
public void executeReport( Locale locale )
{
RepositoryUtils repoUtils = new RepositoryUtils( wagonManager,
settings, mavenProjectBuilder, factory, resolver,
@@ -143,6 +158,16 @@
r.render();
}
+ /** [EMAIL PROTECTED] */
+ public String getOutputName()
+ {
+ return "dependencies";
+ }
+
+ // ----------------------------------------------------------------------
+ // Private methods
+ // ----------------------------------------------------------------------
+
private DependencyTree resolveProject()
{
try
@@ -155,13 +180,5 @@
getLog().error( "Unable to build dependency tree.", e );
return null;
}
- }
-
- /**
- * @see org.apache.maven.reporting.MavenReport#getOutputName()
- */
- public String getOutputName()
- {
- return "dependencies";
}
}
Modified:
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/DependencyConvergenceReport.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/DependencyConvergenceReport.java?rev=600123&r1=600122&r2=600123&view=diff
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/DependencyConvergenceReport.java
(original)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/DependencyConvergenceReport.java
Sat Dec 1 05:41:15 2007
@@ -39,7 +39,8 @@
*
* @author <a href="mailto:[EMAIL PROTECTED]">Joakim Erdfelt</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Vincent Siveton </a>
- * @version $Id $
+ * @version $Id$
+ * @since 2.0
* @goal dependency-convergence
* @aggregator
*/
@@ -58,33 +59,40 @@
*/
private List reactorProjects;
- /**
- * @see org.apache.maven.reporting.AbstractMavenReport#getOutputName()
- */
+ // ----------------------------------------------------------------------
+ // Public methods
+ // ----------------------------------------------------------------------
+
+ /** [EMAIL PROTECTED] */
public String getOutputName()
{
return "dependency-convergence";
}
- /**
- * @see
org.apache.maven.reporting.AbstractMavenReport#getName(java.util.Locale)
- */
+ /** [EMAIL PROTECTED] */
public String getName( Locale locale )
{
return getI18nString( locale, "name" );
}
- /**
- * @see
org.apache.maven.reporting.AbstractMavenReport#getDescription(java.util.Locale)
- */
+ /** [EMAIL PROTECTED] */
public String getDescription( Locale locale )
{
return getI18nString( locale, "description" );
}
- /**
- * @see
org.apache.maven.reporting.AbstractMavenReport#executeReport(java.util.Locale)
- */
+ /** [EMAIL PROTECTED] */
+ public boolean canGenerateReport()
+ {
+ // only generate the convergency report if we are running a reactor
build
+ return reactorProjects.size() > 1;
+ }
+
+ // ----------------------------------------------------------------------
+ // Protected methods
+ // ----------------------------------------------------------------------
+
+ /** [EMAIL PROTECTED] */
protected void executeReport( Locale locale )
throws MavenReportException
{
@@ -123,6 +131,10 @@
sink.flush();
}
+ // ----------------------------------------------------------------------
+ // Private methods
+ // ----------------------------------------------------------------------
+
/**
* Generate the convergenec table for all dependencies
*
@@ -236,7 +248,7 @@
/**
* Produce a Map of relationships between dependencies (its version) and
* reactor projects.
- *
+ *
* This is the structure of the Map:
* <pre>
* +--------------------+----------------------------------+
@@ -587,9 +599,7 @@
return project;
}
- /**
- * @see java.lang.Object#toString()
- */
+ /** [EMAIL PROTECTED] */
public String toString()
{
return project.getId();
@@ -599,9 +609,7 @@
private static class ProjectComparator
implements Comparator
{
- /**
- * @see java.util.Comparator#compare(java.lang.Object,
java.lang.Object)
- */
+ /** [EMAIL PROTECTED] */
public int compare( Object o1, Object o2 )
{
if ( o1 instanceof ReverseDependencyLink && o2 instanceof
ReverseDependencyLink )
@@ -613,14 +621,5 @@
return 0;
}
- }
-
- /**
- * @see org.apache.maven.reporting.AbstractMavenReport#canGenerateReport()
- */
- public boolean canGenerateReport()
- {
- // only generate the convergency report if we are running a reactor
build
- return reactorProjects.size() > 1;
}
}
Modified:
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/IssueTrackingReport.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/IssueTrackingReport.java?rev=600123&r1=600122&r2=600123&view=diff
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/IssueTrackingReport.java
(original)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/IssueTrackingReport.java
Sat Dec 1 05:41:15 2007
@@ -33,30 +33,29 @@
*
* @author <a href="mailto:[EMAIL PROTECTED]">Vincent Siveton </a>
* @version $Id$
+ * @since 2.0
* @goal issue-tracking
*/
public class IssueTrackingReport
extends AbstractProjectInfoReport
{
- /**
- * @see org.apache.maven.reporting.MavenReport#getName(java.util.Locale)
- */
+ // ----------------------------------------------------------------------
+ // Public methods
+ // ----------------------------------------------------------------------
+
+ /** [EMAIL PROTECTED] */
public String getName( Locale locale )
{
return i18n.getString( "project-info-report", locale,
"report.issuetracking.name" );
}
- /**
- * @see
org.apache.maven.reporting.MavenReport#getDescription(java.util.Locale)
- */
+ /** [EMAIL PROTECTED] */
public String getDescription( Locale locale )
{
return i18n.getString( "project-info-report", locale,
"report.issuetracking.description" );
}
- /**
- * @see
org.apache.maven.reporting.AbstractMavenReport#executeReport(java.util.Locale)
- */
+ /** [EMAIL PROTECTED] */
public void executeReport( Locale locale )
{
IssueTrackingRenderer r = new IssueTrackingRenderer( getSink(),
getProject().getModel(), i18n, locale );
@@ -64,14 +63,16 @@
r.render();
}
- /**
- * @see org.apache.maven.reporting.MavenReport#getOutputName()
- */
+ /** [EMAIL PROTECTED] */
public String getOutputName()
{
return "issue-tracking";
}
+ // ----------------------------------------------------------------------
+ // Private
+ // ----------------------------------------------------------------------
+
private static class IssueTrackingRenderer
extends AbstractMavenReportRenderer
{
@@ -92,17 +93,13 @@
this.locale = locale;
}
- /**
- * @see org.apache.maven.reporting.MavenReportRenderer#getTitle()
- */
+ /** [EMAIL PROTECTED] */
public String getTitle()
{
return i18n.getString( "project-info-report", locale,
"report.issuetracking.title" );
}
- /**
- * @see
org.apache.maven.reporting.AbstractMavenReportRenderer#renderBody()
- */
+ /** [EMAIL PROTECTED] */
public void renderBody()
{
IssueManagement issueManagement = model.getIssueManagement();
Modified:
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/LicenseReport.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/LicenseReport.java?rev=600123&r1=600122&r2=600123&view=diff
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/LicenseReport.java
(original)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/LicenseReport.java
Sat Dec 1 05:41:15 2007
@@ -49,6 +49,7 @@
*
* @author <a href="mailto:[EMAIL PROTECTED]">Vincent Siveton </a>
* @version $Id$
+ * @since 2.0
* @goal license
*/
public class LicenseReport
@@ -70,25 +71,23 @@
*/
private boolean offline;
- /**
- * @see org.apache.maven.reporting.MavenReport#getName(java.util.Locale)
- */
+ // ----------------------------------------------------------------------
+ // Public methods
+ // ----------------------------------------------------------------------
+
+ /** [EMAIL PROTECTED] */
public String getName( Locale locale )
{
return i18n.getString( "project-info-report", locale,
"report.license.name" );
}
- /**
- * @see
org.apache.maven.reporting.MavenReport#getDescription(java.util.Locale)
- */
+ /** [EMAIL PROTECTED] */
public String getDescription( Locale locale )
{
return i18n.getString( "project-info-report", locale,
"report.license.description" );
}
- /**
- * @see
org.apache.maven.reporting.AbstractMavenReport#executeReport(java.util.Locale)
- */
+ /** [EMAIL PROTECTED] */
public void executeReport( Locale locale )
{
if ( !offline )
@@ -103,14 +102,16 @@
}
}
- /**
- * @see org.apache.maven.reporting.MavenReport#getOutputName()
- */
+ /** [EMAIL PROTECTED] */
public String getOutputName()
{
return "license";
}
+ // ----------------------------------------------------------------------
+ // Private
+ // ----------------------------------------------------------------------
+
private static class LicenseRenderer
extends AbstractMavenReportRenderer
{
@@ -135,17 +136,13 @@
this.locale = locale;
}
- /**
- * @see org.apache.maven.reporting.MavenReportRenderer#getTitle()
- */
+ /** [EMAIL PROTECTED] */
public String getTitle()
{
return i18n.getString( "project-info-report", locale,
"report.license.title" );
}
- /**
- * @see
org.apache.maven.reporting.AbstractMavenReportRenderer#renderBody()
- */
+ /** [EMAIL PROTECTED] */
public void renderBody()
{
List licenses = project.getModel().getLicenses();
Modified:
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/MailingListsReport.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/MailingListsReport.java?rev=600123&r1=600122&r2=600123&view=diff
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/MailingListsReport.java
(original)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/MailingListsReport.java
Sat Dec 1 05:41:15 2007
@@ -37,30 +37,29 @@
* @author <a href="mailto:[EMAIL PROTECTED]">Brett Porter </a>
* @author <a href="mailto:[EMAIL PROTECTED]">Vincent Siveton </a>
* @version $Id$
+ * @since 2.0
* @goal mailing-list
*/
public class MailingListsReport
extends AbstractProjectInfoReport
{
- /**
- * @see org.apache.maven.reporting.MavenReport#getName(java.util.Locale)
- */
+ // ----------------------------------------------------------------------
+ // Public methods
+ // ----------------------------------------------------------------------
+
+ /** [EMAIL PROTECTED] */
public String getName( Locale locale )
{
return i18n.getString( "project-info-report", locale,
"report.mailing-lists.name" );
}
- /**
- * @see
org.apache.maven.reporting.MavenReport#getDescription(java.util.Locale)
- */
+ /** [EMAIL PROTECTED] */
public String getDescription( Locale locale )
{
return i18n.getString( "project-info-report", locale,
"report.mailing-lists.description" );
}
- /**
- * @see
org.apache.maven.reporting.AbstractMavenReport#executeReport(java.util.Locale)
- */
+ /** [EMAIL PROTECTED] */
public void executeReport( Locale locale )
{
MailingListsRenderer r = new MailingListsRenderer( getSink(),
getProject().getModel(), i18n, locale );
@@ -68,14 +67,16 @@
r.render();
}
- /**
- * @see org.apache.maven.reporting.MavenReport#getOutputName()
- */
+ /** [EMAIL PROTECTED] */
public String getOutputName()
{
return "mail-lists";
}
+ // ----------------------------------------------------------------------
+ // Private
+ // ----------------------------------------------------------------------
+
private static class MailingListsRenderer
extends AbstractMavenReportRenderer
{
@@ -98,17 +99,13 @@
this.locale = locale;
}
- /**
- * @see org.apache.maven.reporting.MavenReportRenderer#getTitle()
- */
+ /** [EMAIL PROTECTED] */
public String getTitle()
{
return i18n.getString( "project-info-report", locale,
"report.mailing-lists.title" );
}
- /**
- * @see
org.apache.maven.reporting.AbstractMavenReportRenderer#renderBody()
- */
+ /** [EMAIL PROTECTED] */
public void renderBody()
{
List mailingLists = model.getMailingLists();
Modified:
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/ProjectIndexPageReport.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/ProjectIndexPageReport.java?rev=600123&r1=600122&r2=600123&view=diff
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/ProjectIndexPageReport.java
(original)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/ProjectIndexPageReport.java
Sat Dec 1 05:41:15 2007
@@ -22,7 +22,6 @@
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.reporting.AbstractMavenReportRenderer;
-import java.util.List;
import java.util.Locale;
/**
@@ -31,24 +30,23 @@
* @author <a href="mailto:[EMAIL PROTECTED]">Brett Porter </a>
* @author <a href="mailto:[EMAIL PROTECTED]">Vincent Siveton </a>
* @version $Id$
+ * @since 2.0
* @goal index
*/
public class ProjectIndexPageReport
extends AbstractProjectInfoReport
{
- private List reports;
+ // ----------------------------------------------------------------------
+ // Public methods
+ // ----------------------------------------------------------------------
- /**
- * @see org.apache.maven.reporting.MavenReport#getName(java.util.Locale)
- */
+ /** [EMAIL PROTECTED] */
public String getName( Locale locale )
{
return i18n.getString( "project-info-report", locale,
"report.index.title" );
}
- /**
- * @see
org.apache.maven.reporting.MavenReport#getDescription(java.util.Locale)
- */
+ /** [EMAIL PROTECTED] */
public String getDescription( Locale locale )
{
String desc;
@@ -64,9 +62,7 @@
return desc;
}
- /**
- * @see
org.apache.maven.reporting.AbstractMavenReport#executeReport(java.util.Locale)
- */
+ /** [EMAIL PROTECTED] */
public void executeReport( Locale locale )
{
ProjectIndexRenderer r =
@@ -75,14 +71,16 @@
r.render();
}
- /**
- * @see org.apache.maven.reporting.MavenReport#getOutputName()
- */
+ /** [EMAIL PROTECTED] */
public String getOutputName()
{
return "index";
}
+ // ----------------------------------------------------------------------
+ // Private
+ // ----------------------------------------------------------------------
+
private static class ProjectIndexRenderer
extends AbstractMavenReportRenderer
{
@@ -103,17 +101,13 @@
this.name = name;
}
- /**
- * @see org.apache.maven.reporting.MavenReportRenderer#getTitle()
- */
+ /** [EMAIL PROTECTED] */
public String getTitle()
{
return title;
}
- /**
- * @see
org.apache.maven.reporting.AbstractMavenReportRenderer#renderBody()
- */
+ /** [EMAIL PROTECTED] */
public void renderBody()
{
startSection( title.trim() + " " + name );
@@ -123,5 +117,4 @@
endSection();
}
}
-
}
Modified:
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/ProjectSummaryReport.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/ProjectSummaryReport.java?rev=600123&r1=600122&r2=600123&view=diff
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/ProjectSummaryReport.java
(original)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/ProjectSummaryReport.java
Sat Dec 1 05:41:15 2007
@@ -30,42 +30,47 @@
* Generates the project information reports summary.
*
* @author Edwin Punzalan
+ * @version $Id$
+ * @since 2.0
* @goal summary
* @plexus.component
*/
public class ProjectSummaryReport
extends AbstractProjectInfoReport
{
+ // ----------------------------------------------------------------------
+ // Public methods
+ // ----------------------------------------------------------------------
+
+ /** [EMAIL PROTECTED] */
protected void executeReport( Locale locale )
throws MavenReportException
{
new ProjectSummaryRenderer( getSink(), locale ).render();
}
- /**
- * @see org.apache.maven.reporting.MavenReport#getName(java.util.Locale)
- */
+ /** [EMAIL PROTECTED] */
public String getName( Locale locale )
{
return i18n.getString( "project-info-report", locale,
"report.summary.name" );
}
- /**
- * @see
org.apache.maven.reporting.MavenReport#getDescription(java.util.Locale)
- */
+ /** [EMAIL PROTECTED] */
public String getDescription( Locale locale )
{
return i18n.getString( "project-info-report", locale,
"report.summary.description" );
}
- /**
- * @see org.apache.maven.reporting.MavenReport#getOutputName()
- */
+ /** [EMAIL PROTECTED] */
public String getOutputName()
{
return "project-summary";
}
+ // ----------------------------------------------------------------------
+ // Private
+ // ----------------------------------------------------------------------
+
private class ProjectSummaryRenderer
extends AbstractMavenReportRenderer
{
@@ -78,11 +83,13 @@
this.locale = locale;
}
+ /** [EMAIL PROTECTED] */
public String getTitle()
{
return getReportString( "report.summary.title" );
}
+ /** [EMAIL PROTECTED] */
protected void renderBody()
{
startSection( getTitle() );
Modified:
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/ScmReport.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/ScmReport.java?rev=600123&r1=600122&r2=600123&view=diff
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/ScmReport.java
(original)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/ScmReport.java
Sat Dec 1 05:41:15 2007
@@ -41,6 +41,7 @@
*
* @author <a href="mailto:[EMAIL PROTECTED]">Vincent Siveton </a>
* @version $Id$
+ * @since 2.0
* @goal scm
*/
public class ScmReport
@@ -87,25 +88,23 @@
*/
private String webAccessUrl;
- /**
- * @see org.apache.maven.reporting.MavenReport#getName(java.util.Locale)
- */
+ // ----------------------------------------------------------------------
+ // Public methods
+ // ----------------------------------------------------------------------
+
+ /** [EMAIL PROTECTED] */
public String getName( Locale locale )
{
return i18n.getString( "project-info-report", locale,
"report.scm.name" );
}
- /**
- * @see
org.apache.maven.reporting.MavenReport#getDescription(java.util.Locale)
- */
+ /** [EMAIL PROTECTED] */
public String getDescription( Locale locale )
{
return i18n.getString( "project-info-report", locale,
"report.scm.description" );
}
- /**
- * @see
org.apache.maven.reporting.AbstractMavenReport#executeReport(java.util.Locale)
- */
+ /** [EMAIL PROTECTED] */
public void executeReport( Locale locale )
{
ScmRenderer r =
@@ -115,14 +114,16 @@
r.render();
}
- /**
- * @see org.apache.maven.reporting.MavenReport#getOutputName()
- */
+ /** [EMAIL PROTECTED] */
public String getOutputName()
{
return "source-repository";
}
+ // ----------------------------------------------------------------------
+ // Private
+ // ----------------------------------------------------------------------
+
private static class ScmRenderer
extends AbstractMavenReportRenderer
{
@@ -168,17 +169,13 @@
}
- /**
- * @see org.apache.maven.reporting.MavenReportRenderer#getTitle()
- */
+ /** [EMAIL PROTECTED] */
public String getTitle()
{
return i18n.getString( "project-info-report", locale,
"report.scm.title" );
}
- /**
- * @see
org.apache.maven.reporting.AbstractMavenReportRenderer#renderBody()
- */
+ /** [EMAIL PROTECTED] */
public void renderBody()
{
Scm scm = model.getScm();
Modified:
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/TeamListReport.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/TeamListReport.java?rev=600123&r1=600122&r2=600123&view=diff
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/TeamListReport.java
(original)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/TeamListReport.java
Sat Dec 1 05:41:15 2007
@@ -40,30 +40,29 @@
*
* @author <a href="mailto:[EMAIL PROTECTED]">Vincent Siveton </a>
* @version $Id$
+ * @since 2.0
* @goal project-team
*/
public class TeamListReport
extends AbstractProjectInfoReport
{
- /**
- * @see org.apache.maven.reporting.MavenReport#getName(java.util.Locale)
- */
+ // ----------------------------------------------------------------------
+ // Public methods
+ // ----------------------------------------------------------------------
+
+ /** [EMAIL PROTECTED] */
public String getName( Locale locale )
{
return i18n.getString( "project-info-report", locale,
"report.team-list.name" );
}
- /**
- * @see
org.apache.maven.reporting.MavenReport#getDescription(java.util.Locale)
- */
+ /** [EMAIL PROTECTED] */
public String getDescription( Locale locale )
{
return i18n.getString( "project-info-report", locale,
"report.team-list.description" );
}
- /**
- * @see
org.apache.maven.reporting.AbstractMavenReport#executeReport(java.util.Locale)
- */
+ /** [EMAIL PROTECTED] */
public void executeReport( Locale locale )
{
TeamListRenderer r = new TeamListRenderer( getSink(),
project.getModel(), i18n, locale );
@@ -71,14 +70,16 @@
r.render();
}
- /**
- * @see org.apache.maven.reporting.MavenReport#getOutputName()
- */
+ /** [EMAIL PROTECTED] */
public String getOutputName()
{
return "team-list";
}
+ // ----------------------------------------------------------------------
+ // Private
+ // ----------------------------------------------------------------------
+
private static class TeamListRenderer
extends AbstractMavenReportRenderer
{
@@ -119,17 +120,13 @@
this.locale = locale;
}
- /**
- * @see org.apache.maven.reporting.MavenReportRenderer#getTitle()
- */
+ /** [EMAIL PROTECTED] */
public String getTitle()
{
return i18n.getString( "project-info-report", locale,
"report.team-list.title" );
}
- /**
- * @see
org.apache.maven.reporting.AbstractMavenReportRenderer#renderBody()
- */
+ /** [EMAIL PROTECTED] */
public void renderBody()
{
startSection( i18n.getString( "project-info-report", locale,
"report.team-list.intro.title" ) );
Modified:
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/Dependencies.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/Dependencies.java?rev=600123&r1=600122&r2=600123&view=diff
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/Dependencies.java
(original)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/Dependencies.java
Sat Dec 1 05:41:15 2007
@@ -35,6 +35,10 @@
import java.util.List;
import java.util.Map;
+/**
+ * @version $Id$
+ * @since 2.1
+ */
public class Dependencies
{
private final List projectDependencies;
Modified:
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/DependenciesReportConfiguration.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/DependenciesReportConfiguration.java?rev=600123&r1=600122&r2=600123&view=diff
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/DependenciesReportConfiguration.java
(original)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/DependenciesReportConfiguration.java
Sat Dec 1 05:41:15 2007
@@ -19,6 +19,10 @@
* under the License.
*/
+/**
+ * @version $Id$
+ * @since 2.1
+ */
public class DependenciesReportConfiguration
{
private boolean dependencyDetailsEnabled;
@@ -38,7 +42,7 @@
public boolean getDependencyLocationsEnabled()
{
- //TODO:
+ //TODO:
// ( !settings.isOffline() && dependencyLocationsEnabled )
return dependencyLocationsEnabled;
}
Modified:
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/RepositoryUtils.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/RepositoryUtils.java?rev=600123&r1=600122&r2=600123&view=diff
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/RepositoryUtils.java
(original)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/RepositoryUtils.java
Sat Dec 1 05:41:15 2007
@@ -46,6 +46,10 @@
import java.util.ArrayList;
import java.util.List;
+/**
+ * @version $Id$
+ * @since 2.1
+ */
public class RepositoryUtils
{
private Log log;
Modified:
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/renderer/DependenciesRenderer.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/renderer/DependenciesRenderer.java?rev=600123&r1=600122&r2=600123&view=diff
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/renderer/DependenciesRenderer.java
(original)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/renderer/DependenciesRenderer.java
Sat Dec 1 05:41:15 2007
@@ -54,6 +54,10 @@
import java.util.Locale;
import java.util.Map;
+/**
+ * @version $Id$
+ * @since 2.1
+ */
public class DependenciesRenderer
extends AbstractMavenReportRenderer
{
@@ -89,6 +93,7 @@
*/
private Map licenseMap = new HashMap()
{
+ /** [EMAIL PROTECTED] */
public Object put( Object key, Object value )
{
// handle multiple values as a list
@@ -121,16 +126,22 @@
this.configuration = config;
}
+ // ----------------------------------------------------------------------
+ // Public methods
+ // ----------------------------------------------------------------------
+
public void setLog( Log log )
{
this.log = log;
}
+ /** [EMAIL PROTECTED] */
public String getTitle()
{
return getReportString( "report.dependencies.title" );
}
+ /** [EMAIL PROTECTED] */
public void renderBody()
{
// Dependencies report
@@ -186,6 +197,10 @@
renderSectionDependencyRepositoryLocations();
}
}
+
+ // ----------------------------------------------------------------------
+ // Private methods
+ // ----------------------------------------------------------------------
private String[] getDependencyTableHeader()
{
