You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by rf...@apache.org on 2019/06/08 21:01:20 UTC
[maven-docck-plugin] branch MDOCCK-33 created (now 9411b14)
This is an automated email from the ASF dual-hosted git repository.
rfscholte pushed a change to branch MDOCCK-33
in repository https://gitbox.apache.org/repos/asf/maven-docck-plugin.git.
at 9411b14 [MDOCCK-33] Require Java 7
This branch includes the following new commits:
new 9411b14 [MDOCCK-33] Require Java 7
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[maven-docck-plugin] 01/01: [MDOCCK-33] Require Java 7
Posted by rf...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rfscholte pushed a commit to branch MDOCCK-33
in repository https://gitbox.apache.org/repos/asf/maven-docck-plugin.git
commit 9411b141bec1f68342a5785dc9d5a0dd1ec15620
Author: rfscholte <rf...@apache.org>
AuthorDate: Sat Jun 8 23:01:12 2019 +0200
[MDOCCK-33] Require Java 7
---
pom.xml | 1 +
.../docck/AbstractCheckDocumentationMojo.java | 25 +++++++---------------
.../plugin/docck/CheckPluginDocumentationMojo.java | 17 +++++----------
.../docck/reports/AbstractDocumentationReport.java | 1 +
.../docck/reports/DocumentationReporter.java | 6 +++---
.../docck/reports/ErrorDocumentationReport.java | 1 +
.../docck/reports/InfoDocumentationReport.java | 1 +
.../docck/reports/WarningDocumentationReport.java | 1 +
8 files changed, 21 insertions(+), 32 deletions(-)
diff --git a/pom.xml b/pom.xml
index f9e21e2..4c397a9 100644
--- a/pom.xml
+++ b/pom.xml
@@ -63,6 +63,7 @@ under the License.
<properties>
<mavenVersion>2.2.1</mavenVersion>
+ <javaVersion>7</javaVersion>
</properties>
<dependencies>
diff --git a/src/main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java b/src/main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java
index f6659b5..4f8c250 100644
--- a/src/main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java
+++ b/src/main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java
@@ -42,7 +42,6 @@ import org.apache.maven.settings.Proxy;
import org.apache.maven.settings.Settings;
import org.apache.maven.shared.model.fileset.FileSet;
import org.apache.maven.shared.model.fileset.util.FileSetManager;
-import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.StringUtils;
import java.io.File;
@@ -103,7 +102,7 @@ public abstract class AbstractCheckDocumentationMojo
private FileSetManager fileSetManager = new FileSetManager();
- private List<String> validUrls = new ArrayList<String>();
+ private List<String> validUrls = new ArrayList<>();
protected AbstractCheckDocumentationMojo()
{
@@ -122,6 +121,7 @@ public abstract class AbstractCheckDocumentationMojo
return reactorProjects;
}
+ @Override
public void execute()
throws MojoExecutionException, MojoFailureException
{
@@ -132,7 +132,7 @@ public abstract class AbstractCheckDocumentationMojo
getLog().info( "Writing documentation check results to: " + output );
}
- Map<MavenProject, DocumentationReporter> reporters = new LinkedHashMap<MavenProject, DocumentationReporter>();
+ Map<MavenProject, DocumentationReporter> reporters = new LinkedHashMap<>();
boolean hasErrors = false;
for ( MavenProject project : reactorProjects )
@@ -240,7 +240,7 @@ public abstract class AbstractCheckDocumentationMojo
if ( !reporter.getMessages().isEmpty() )
{
- buffer.append( "\no " ).append( project.getName() );
+ buffer.append( System.lineSeparator() ).append( "o " ).append( project.getName() );
buffer.append( " (" );
final int numberOfErrors = reporter.getMessagesByType( DocumentationReport.TYPE_ERROR ).size();
buffer.append( numberOfErrors ).append( " error" ).append( numberOfErrors == 1 ? "" : "s" );
@@ -248,18 +248,18 @@ public abstract class AbstractCheckDocumentationMojo
final int numberOfWarnings = reporter.getMessagesByType( DocumentationReport.TYPE_WARN ).size();
buffer.append( numberOfWarnings ).append( " warning" ).append( numberOfWarnings == 1 ? "" : "s" );
buffer.append( ")" );
- buffer.append( "\n" );
+ buffer.append( System.lineSeparator() );
for ( String error : reporter.getMessages() )
{
- buffer.append( " " ).append( error ).append( "\n" );
+ buffer.append( " " ).append( error ).append( System.lineSeparator() );
}
}
}
if ( buffer.length() > 0 )
{
- messages = "The following documentation problems were found:\n" + buffer.toString();
+ messages = "The following documentation problems were found:" + System.lineSeparator() + buffer.toString();
}
return messages;
@@ -279,18 +279,9 @@ public abstract class AbstractCheckDocumentationMojo
{
if ( output != null )
{
- FileWriter writer = null;
-
- try
+ try ( FileWriter writer = new FileWriter( output ) )
{
- writer = new FileWriter( output );
writer.write( messages );
- writer.close();
- writer = null;
- }
- finally
- {
- IOUtil.close( writer );
}
}
else
diff --git a/src/main/java/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.java b/src/main/java/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.java
index 1a24734..e92a6f4 100644
--- a/src/main/java/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.java
+++ b/src/main/java/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.java
@@ -59,6 +59,7 @@ public class CheckPluginDocumentationMojo
// TODO: really a description of length 1 isn't all that helpful...
private static final int MIN_DESCRIPTION_LENGTH = 1;
+ @Override
protected void checkPackagingSpecificDocumentation( MavenProject project, DocumentationReporter reporter )
{
PluginDescriptor descriptor = new PluginDescriptor();
@@ -125,6 +126,7 @@ public class CheckPluginDocumentationMojo
checkProjectSite( project, reporter );
}
+ @Override
protected boolean approveProjectPackaging( String packaging )
{
return "maven-plugin".equals( packaging );
@@ -143,16 +145,11 @@ public class CheckPluginDocumentationMojo
}
else
{
- Reader streamReader = null;
- try
+
+ try ( Reader streamReader = ReaderFactory.newXmlReader( siteXml ) )
{
- streamReader = ReaderFactory.newXmlReader( siteXml );
-
String siteHtml = IOUtil.toString( streamReader );
- streamReader.close();
- streamReader = null;
-
if ( !siteHtml.contains( "href=\"index.html\"" ) )
{
reporter.error( "site.xml is missing the link to: index.html \"Introduction\"." );
@@ -178,10 +175,6 @@ public class CheckPluginDocumentationMojo
reporter.error( "Unable to read site.xml file: \'" + siteXml.getAbsolutePath() + "\'.\nError: "
+ e.getMessage() );
}
- finally
- {
- IOUtil.close( streamReader );
- }
}
// check for index.(apt|html|xml)[.vm]
@@ -248,7 +241,7 @@ public class CheckPluginDocumentationMojo
*/
private List<String> getRequiredPlugins()
{
- List<String> list = new ArrayList<String>();
+ List<String> list = new ArrayList<>();
list.add( "maven-javadoc-plugin" );
list.add( "maven-jxr-plugin" );
diff --git a/src/main/java/org/apache/maven/plugin/docck/reports/AbstractDocumentationReport.java b/src/main/java/org/apache/maven/plugin/docck/reports/AbstractDocumentationReport.java
index 1ca5ede..eaa9755 100644
--- a/src/main/java/org/apache/maven/plugin/docck/reports/AbstractDocumentationReport.java
+++ b/src/main/java/org/apache/maven/plugin/docck/reports/AbstractDocumentationReport.java
@@ -32,6 +32,7 @@ public abstract class AbstractDocumentationReport
this.message = message;
}
+ @Override
public String getMessage()
{
return message;
diff --git a/src/main/java/org/apache/maven/plugin/docck/reports/DocumentationReporter.java b/src/main/java/org/apache/maven/plugin/docck/reports/DocumentationReporter.java
index 96fd45f..ba3265c 100644
--- a/src/main/java/org/apache/maven/plugin/docck/reports/DocumentationReporter.java
+++ b/src/main/java/org/apache/maven/plugin/docck/reports/DocumentationReporter.java
@@ -27,7 +27,7 @@ import java.util.ArrayList;
*/
public class DocumentationReporter
{
- private List<DocumentationReport> reports = new ArrayList<DocumentationReport>();
+ private List<DocumentationReport> reports = new ArrayList<>();
public void info( String message )
{
@@ -46,7 +46,7 @@ public class DocumentationReporter
public List<String> getMessagesByType( int type )
{
- List<String> list = new ArrayList<String>();
+ List<String> list = new ArrayList<>();
for ( DocumentationReport report : reports )
{
@@ -61,7 +61,7 @@ public class DocumentationReporter
public List<String> getMessages()
{
- List<String> list = new ArrayList<String>();
+ List<String> list = new ArrayList<>();
for ( DocumentationReport report : reports )
{
diff --git a/src/main/java/org/apache/maven/plugin/docck/reports/ErrorDocumentationReport.java b/src/main/java/org/apache/maven/plugin/docck/reports/ErrorDocumentationReport.java
index e73e8ff..90b4c0b 100644
--- a/src/main/java/org/apache/maven/plugin/docck/reports/ErrorDocumentationReport.java
+++ b/src/main/java/org/apache/maven/plugin/docck/reports/ErrorDocumentationReport.java
@@ -30,6 +30,7 @@ public class ErrorDocumentationReport
super( message );
}
+ @Override
public int getType()
{
return DocumentationReport.TYPE_ERROR;
diff --git a/src/main/java/org/apache/maven/plugin/docck/reports/InfoDocumentationReport.java b/src/main/java/org/apache/maven/plugin/docck/reports/InfoDocumentationReport.java
index 69c06ea..959081c 100644
--- a/src/main/java/org/apache/maven/plugin/docck/reports/InfoDocumentationReport.java
+++ b/src/main/java/org/apache/maven/plugin/docck/reports/InfoDocumentationReport.java
@@ -30,6 +30,7 @@ public class InfoDocumentationReport
super( message );
}
+ @Override
public int getType()
{
return DocumentationReport.TYPE_INFO;
diff --git a/src/main/java/org/apache/maven/plugin/docck/reports/WarningDocumentationReport.java b/src/main/java/org/apache/maven/plugin/docck/reports/WarningDocumentationReport.java
index 8474b2c..9813f99 100644
--- a/src/main/java/org/apache/maven/plugin/docck/reports/WarningDocumentationReport.java
+++ b/src/main/java/org/apache/maven/plugin/docck/reports/WarningDocumentationReport.java
@@ -30,6 +30,7 @@ public class WarningDocumentationReport
super( message );
}
+ @Override
public int getType()
{
return DocumentationReport.TYPE_WARN;