Author: rdonkin
Date: Fri May 27 14:16:09 2011
New Revision: 1128317
URL: http://svn.apache.org/viewvc?rev=1128317&view=rev
Log:
MAILETDOCS-4 Add logging to aid debugging.
Modified:
james/mailet/maven-mailetdocs-plugin/trunk/src/main/java/org/apache/james/mailet/AbstractMailetdocsReport.java
james/mailet/maven-mailetdocs-plugin/trunk/src/main/java/org/apache/james/mailet/AggregateMailetdocsReport.java
james/mailet/maven-mailetdocs-plugin/trunk/src/main/java/org/apache/james/mailet/MailetdocsReport.java
Modified:
james/mailet/maven-mailetdocs-plugin/trunk/src/main/java/org/apache/james/mailet/AbstractMailetdocsReport.java
URL:
http://svn.apache.org/viewvc/james/mailet/maven-mailetdocs-plugin/trunk/src/main/java/org/apache/james/mailet/AbstractMailetdocsReport.java?rev=1128317&r1=1128316&r2=1128317&view=diff
==============================================================================
---
james/mailet/maven-mailetdocs-plugin/trunk/src/main/java/org/apache/james/mailet/AbstractMailetdocsReport.java
(original)
+++
james/mailet/maven-mailetdocs-plugin/trunk/src/main/java/org/apache/james/mailet/AbstractMailetdocsReport.java
Fri May 27 14:16:09 2011
@@ -156,9 +156,17 @@ public abstract class AbstractMailetdocs
}
});
+ logDescriptors(descriptors);
return descriptors;
}
+ private void logDescriptors(
+ final List<MailetMatcherDescriptor> descriptors) {
+ if (getLog().isDebugEnabled()) {
+ getLog().debug("Built descriptors: " + descriptors);
+ }
+ }
+
protected abstract List<MailetMatcherDescriptor>
buildDescriptors(MavenProject project);
private void outputDescriptorIndex(List<MailetMatcherDescriptor>
descriptors, String title) {
Modified:
james/mailet/maven-mailetdocs-plugin/trunk/src/main/java/org/apache/james/mailet/AggregateMailetdocsReport.java
URL:
http://svn.apache.org/viewvc/james/mailet/maven-mailetdocs-plugin/trunk/src/main/java/org/apache/james/mailet/AggregateMailetdocsReport.java?rev=1128317&r1=1128316&r2=1128317&view=diff
==============================================================================
---
james/mailet/maven-mailetdocs-plugin/trunk/src/main/java/org/apache/james/mailet/AggregateMailetdocsReport.java
(original)
+++
james/mailet/maven-mailetdocs-plugin/trunk/src/main/java/org/apache/james/mailet/AggregateMailetdocsReport.java
Fri May 27 14:16:09 2011
@@ -25,7 +25,11 @@ import org.apache.maven.project.MavenPro
/**
- * <p>Generates catalog and reports on mailets and matchers.</p>
+ * <p>
+ * Generates catalog and reports on mailets and matchers.
+ * Aggregates mailets and matcher within subprojects
+ * when run from the top level.
+ * </p>
* <h4>Notes</h4>
* <ul>
* <li>Should only used as a report.</li>
@@ -44,17 +48,43 @@ public class AggregateMailetdocsReport e
*/
private List<MavenProject> reactorProjects;
- protected List<MailetMatcherDescriptor> buildDescriptors(MavenProject
project) {
+ /**
+ * Build descriptors for mailets contained
+ * within subprojects.
+ * @param project not null
+ */
+ protected final List<MailetMatcherDescriptor>
buildDescriptors(MavenProject project) {
final DefaultDescriptorsExtractor extractor = new
DefaultDescriptorsExtractor();
if (project.isExecutionRoot()) {
+ logProject(project);
for (final MavenProject subproject : reactorProjects) {
+ logSubproject(subproject);
extractor.extract(subproject, getLog());
}
} else {
+ logNoSubprojects(project);
extractor.extract(project, getLog());
}
final List<MailetMatcherDescriptor> descriptors =
extractor.descriptors();
return descriptors;
}
+
+ private void logProject(MavenProject project) {
+ if (getLog().isDebugEnabled()) {
+ getLog().debug("Aggregating mailets within " + project.getName());
+ }
+ }
+
+ private void logSubproject(final MavenProject subproject) {
+ if (getLog().isDebugEnabled()) {
+ getLog().debug("Adding descriptors in " + subproject.getName());
+ }
+ }
+
+ private void logNoSubprojects(MavenProject project) {
+ if (getLog().isDebugEnabled()) {
+ getLog().debug("No subprojects for " + project.getName());
+ }
+ }
}
Modified:
james/mailet/maven-mailetdocs-plugin/trunk/src/main/java/org/apache/james/mailet/MailetdocsReport.java
URL:
http://svn.apache.org/viewvc/james/mailet/maven-mailetdocs-plugin/trunk/src/main/java/org/apache/james/mailet/MailetdocsReport.java?rev=1128317&r1=1128316&r2=1128317&view=diff
==============================================================================
---
james/mailet/maven-mailetdocs-plugin/trunk/src/main/java/org/apache/james/mailet/MailetdocsReport.java
(original)
+++
james/mailet/maven-mailetdocs-plugin/trunk/src/main/java/org/apache/james/mailet/MailetdocsReport.java
Fri May 27 14:16:09 2011
@@ -37,9 +37,21 @@ import org.apache.maven.project.MavenPro
*/
public class MailetdocsReport extends AbstractMailetdocsReport {
+ /**
+ * Builds descriptors for the given project only,
+ * without recursion.
+ * @param project not null
+ */
protected List<MailetMatcherDescriptor> buildDescriptors(final
MavenProject project) {
+ logProject(project);
final List<MailetMatcherDescriptor> descriptors = new
DefaultDescriptorsExtractor().extract(project, getLog()).descriptors();
return descriptors;
}
+
+ private void logProject(final MavenProject project) {
+ if (getLog().isDebugEnabled()) {
+ getLog().debug("Building descriptors for " + project.getName());
+ }
+ }
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
