Skip to content

Commit 488624f

Browse files
committed
[MJAVADOC-782] Align read-only parameters naming with other plugins
This closes #251
1 parent 867dc73 commit 488624f

File tree

5 files changed

+35
-14
lines changed

5 files changed

+35
-14
lines changed

src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java

+10-6
Original file line numberDiff line numberDiff line change
@@ -328,8 +328,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo {
328328
@Parameter(defaultValue = "${project}", readonly = true, required = true)
329329
protected MavenProject project;
330330

331-
@Parameter(defaultValue = "${mojoExecution}", readonly = true)
332-
private MojoExecution mojo;
331+
@Parameter(defaultValue = "${mojoExecution}", readonly = true, required = true)
332+
protected MojoExecution mojoExecution;
333333

334334
/**
335335
* Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline
@@ -421,8 +421,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo {
421421
/**
422422
* The projects in the reactor for aggregation report.
423423
*/
424-
@Parameter(property = "reactorProjects", readonly = true)
425-
private List<MavenProject> reactorProjects;
424+
@Parameter(defaultValue = "${reactorProjects}", required = true, readonly = true)
425+
protected List<MavenProject> reactorProjects;
426426

427427
/**
428428
* Set this to <code>true</code> to debug the Javadoc plugin. With this, <code>javadoc.bat(or.sh)</code>,
@@ -1828,7 +1828,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
18281828
abstract void doExecute() throws MojoExecutionException, MojoFailureException;
18291829

18301830
protected final void verifyRemovedParameter(String paramName) {
1831-
Xpp3Dom configDom = mojo.getConfiguration();
1831+
Xpp3Dom configDom = mojoExecution.getConfiguration();
18321832
if (configDom != null) {
18331833
if (configDom.getChild(paramName) != null) {
18341834
throw new IllegalArgumentException(
@@ -1838,7 +1838,7 @@ protected final void verifyRemovedParameter(String paramName) {
18381838
}
18391839

18401840
private void verifyReplacedParameter(String oldParamName, String newParamNew) {
1841-
Xpp3Dom configDom = mojo.getConfiguration();
1841+
Xpp3Dom configDom = mojoExecution.getConfiguration();
18421842
if (configDom != null) {
18431843
if (configDom.getChild(oldParamName) != null) {
18441844
throw new IllegalArgumentException("parameter '" + oldParamName + "' has been replaced with "
@@ -6042,6 +6042,10 @@ protected void logError(String message, Throwable t) {
60426042
}
60436043
}
60446044

6045+
protected List<MavenProject> getReactorProjects() {
6046+
return reactorProjects;
6047+
}
6048+
60456049
/**
60466050
* @param prefix The prefix of the exception.
60476051
* @param e The exception.

src/test/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReportTest.java

+6-2
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,12 @@ protected void setUp() throws Exception {
6262
private JavadocReport lookupMojo(File testPom) throws Exception {
6363
JavadocReport mojo = (JavadocReport) lookupMojo("aggregate", testPom);
6464

65-
MojoExecution mojoExec = new MojoExecution(new Plugin(), "aggregate", null);
66-
setVariableValueToObject(mojo, "mojo", mojoExec);
65+
Plugin p = new Plugin();
66+
p.setGroupId("org.apache.maven.plugins");
67+
p.setArtifactId("maven-javadoc-plugin");
68+
MojoExecution mojoExecution = new MojoExecution(p, "aggregate", null);
69+
70+
setVariableValueToObject(mojo, "mojoExecution", mojoExecution);
6771

6872
MavenProject currentProject = new MavenProjectStub();
6973
currentProject.setGroupId("GROUPID");

src/test/java/org/apache/maven/plugins/javadoc/JavadocJarTest.java

+5-2
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,12 @@ public class JavadocJarTest extends AbstractMojoTestCase {
4949
private JavadocJar lookupMojo(File testPom) throws Exception {
5050
JavadocJar mojo = (JavadocJar) lookupMojo("jar", testPom);
5151

52-
MojoExecution mojoExec = new MojoExecution(new Plugin(), "javadoc", null);
52+
Plugin p = new Plugin();
53+
p.setGroupId("org.apache.maven.plugins");
54+
p.setArtifactId("maven-javadoc-plugin");
55+
MojoExecution mojoExecution = new MojoExecution(p, "jar", null);
5356

54-
setVariableValueToObject(mojo, "mojo", mojoExec);
57+
setVariableValueToObject(mojo, "mojoExecution", mojoExecution);
5558

5659
MavenProject currentProject = new MavenProjectStub();
5760
currentProject.setGroupId("GROUPID");

src/test/java/org/apache/maven/plugins/javadoc/JavadocReportTest.java

+9-2
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
import java.nio.file.Files;
2828
import java.nio.file.Path;
2929
import java.nio.file.Paths;
30+
import java.util.Collections;
3031
import java.util.HashMap;
3132
import java.util.List;
3233
import java.util.Map;
@@ -113,17 +114,23 @@ protected void tearDown() throws Exception {
113114
private JavadocReport lookupMojo(Path testPom) throws Exception {
114115
JavadocReport mojo = (JavadocReport) lookupMojo("javadoc", testPom.toFile());
115116

116-
MojoExecution mojoExec = new MojoExecution(new Plugin(), "javadoc", null);
117+
Plugin p = new Plugin();
118+
p.setGroupId("org.apache.maven.plugins");
119+
p.setArtifactId("maven-javadoc-plugin");
120+
MojoExecution mojoExecution = new MojoExecution(p, "javadoc", null);
117121

118-
setVariableValueToObject(mojo, "mojo", mojoExec);
122+
setVariableValueToObject(mojo, "mojoExecution", mojoExecution);
119123

120124
MavenProject currentProject = new MavenProjectStub();
121125
currentProject.setGroupId("GROUPID");
122126
currentProject.setArtifactId("ARTIFACTID");
123127

128+
List<MavenProject> reactorProjects =
129+
mojo.getReactorProjects() != null ? mojo.getReactorProjects() : Collections.emptyList();
124130
MavenSession session = newMavenSession(currentProject);
125131
setVariableValueToObject(mojo, "session", session);
126132
setVariableValueToObject(mojo, "repoSession", session.getRepositorySession());
133+
setVariableValueToObject(mojo, "reactorProjects", reactorProjects);
127134
return mojo;
128135
}
129136

src/test/java/org/apache/maven/plugins/javadoc/TestJavadocReportTest.java

+5-2
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,12 @@ public void testTestJavadoc() throws Exception {
4343
new File(getBasedir(), "src/test/resources/unit/test-javadoc-test/test-javadoc-test-plugin-config.xml");
4444
TestJavadocReport mojo = (TestJavadocReport) lookupMojo("test-javadoc", testPom);
4545

46-
MojoExecution mojoExec = new MojoExecution(new Plugin(), "test-javadoc", null);
46+
Plugin p = new Plugin();
47+
p.setGroupId("org.apache.maven.plugins");
48+
p.setArtifactId("maven-javadoc-plugin");
49+
MojoExecution mojoExecution = new MojoExecution(p, "test-javadoc", null);
4750

48-
setVariableValueToObject(mojo, "mojo", mojoExec);
51+
setVariableValueToObject(mojo, "mojoExecution", mojoExecution);
4952

5053
MavenProject currentProject = new MavenProjectStub();
5154
currentProject.setGroupId("GROUPID");

0 commit comments

Comments
 (0)