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 2018/06/30 20:54:05 UTC
[maven-jxr] 01/02: Add @Override
This is an automated email from the ASF dual-hosted git repository.
rfscholte pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-jxr.git
commit 636c52c0478f1b46a08eb91735ca1a0d156615aa
Author: rfscholte <rf...@apache.org>
AuthorDate: Sat Jun 30 21:25:05 2018 +0200
Add @Override
---
.../apache/maven/plugin/jxr/AbstractJxrReport.java | 26 ++++++------------
.../maven/plugin/jxr/AggregatorJxrReport.java | 1 +
.../maven/plugin/jxr/AggregatorJxrTestReport.java | 1 +
.../org/apache/maven/plugin/jxr/JxrReport.java | 32 ++++++----------------
.../org/apache/maven/plugin/jxr/JxrTestReport.java | 32 ++++++----------------
.../apache/maven/plugin/jxr/PluginLogAdapter.java | 16 +++--------
.../org/apache/maven/jxr/ant/DirectoryScanner.java | 1 +
.../org/apache/maven/jxr/log/VelocityLogger.java | 2 ++
.../org/apache/maven/jxr/pacman/ClassType.java | 1 +
.../org/apache/maven/jxr/util/StringEntry.java | 2 ++
10 files changed, 36 insertions(+), 78 deletions(-)
diff --git a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java
index 2ec3b01..0e0f1bc 100644
--- a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java
+++ b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java
@@ -160,6 +160,7 @@ public abstract class AbstractJxrReport
* @return The effective reporting output file encoding, never <code>null</code>: defaults to <code>UTF-8</code>
* instead.
*/
+ @Override
protected String getOutputEncoding()
{
return ( outputEncoding == null ) ? ReaderFactory.UTF_8 : outputEncoding;
@@ -377,25 +378,19 @@ public abstract class AbstractJxrReport
}
- /**
- * @see org.apache.maven.reporting.AbstractMavenReport#getSiteRenderer()
- */
+ @Override
protected Renderer getSiteRenderer()
{
return siteRenderer;
}
- /**
- * @see org.apache.maven.reporting.AbstractMavenReport#getOutputDirectory()
- */
+ @Override
protected String getOutputDirectory()
{
return outputDirectory.getAbsolutePath();
}
- /**
- * @see org.apache.maven.reporting.AbstractMavenReport#getProject()
- */
+ @Override
public MavenProject getProject()
{
return project;
@@ -432,6 +427,7 @@ public abstract class AbstractJxrReport
* since that is configured as an execution, not in the reporting section, at least by some people on some days. We
* do NOT want the default behavior.
*/
+ @Override
public void execute()
throws MojoExecutionException
{
@@ -453,9 +449,7 @@ public abstract class AbstractJxrReport
}
}
- /**
- * @see org.apache.maven.reporting.AbstractMavenReport#executeReport(java.util.Locale)
- */
+ @Override
protected void executeReport( Locale locale )
throws MavenReportException
{
@@ -508,17 +502,13 @@ public abstract class AbstractJxrReport
return sourceDirs;
}
- /**
- * @see org.apache.maven.reporting.AbstractMavenReport#canGenerateReport()
- */
+ @Override
public boolean canGenerateReport()
{
return canGenerateReport( constructSourceDirs() );
}
- /**
- * @see org.apache.maven.reporting.AbstractMavenReport#isExternalReport()
- */
+ @Override
public boolean isExternalReport()
{
return true;
diff --git a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AggregatorJxrReport.java b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AggregatorJxrReport.java
index dbad03a..d5e331b 100644
--- a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AggregatorJxrReport.java
+++ b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AggregatorJxrReport.java
@@ -34,6 +34,7 @@ public class AggregatorJxrReport
extends JxrReport
{
+ @Override
protected boolean isAggregate()
{
return true;
diff --git a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AggregatorJxrTestReport.java b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AggregatorJxrTestReport.java
index 791ce52..9156ac2 100644
--- a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AggregatorJxrTestReport.java
+++ b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AggregatorJxrTestReport.java
@@ -33,6 +33,7 @@ import org.apache.maven.plugins.annotations.Mojo;
public class AggregatorJxrTestReport
extends JxrTestReport
{
+ @Override
protected boolean isAggregate()
{
return true;
diff --git a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrReport.java b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrReport.java
index dc76b16..1d80e3a 100644
--- a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrReport.java
+++ b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrReport.java
@@ -68,17 +68,13 @@ public class JxrReport
@Parameter( defaultValue = "${project.reporting.outputDirectory}/apidocs" )
private File javadocDir;
- /**
- * @see org.apache.maven.plugin.jxr.AbstractJxrReport#getDestinationDirectory()
- */
+ @Override
protected String getDestinationDirectory()
{
return destDir;
}
- /**
- * @see org.apache.maven.plugin.jxr.AbstractJxrReport#getSourceRoots()
- */
+ @Override
protected List<String> getSourceRoots()
{
if ( sourcePath != null )
@@ -108,9 +104,7 @@ public class JxrReport
return l;
}
- /**
- * @see org.apache.maven.plugin.jxr.AbstractJxrReport#getSourceRoots(org.apache.maven.project.MavenProject)
- */
+ @Override
protected List<String> getSourceRoots( MavenProject project )
{
List<String> l = new ArrayList<String>();
@@ -131,41 +125,31 @@ public class JxrReport
return l;
}
- /**
- * @see org.apache.maven.reporting.MavenReport#getDescription(java.util.Locale)
- */
+ @Override
public String getDescription( Locale locale )
{
return getBundle( locale ).getString( "report.xref.main.description" );
}
- /**
- * @see org.apache.maven.reporting.MavenReport#getName(java.util.Locale)
- */
+ @Override
public String getName( Locale locale )
{
return getBundle( locale ).getString( "report.xref.main.name" );
}
- /**
- * @see org.apache.maven.reporting.MavenReport#getOutputName()
- */
+ @Override
public String getOutputName()
{
return "xref/index";
}
- /**
- * @see org.apache.maven.plugin.jxr.AbstractJxrReport#getJavadocDir()
- */
+ @Override
protected File getJavadocDir()
{
return javadocDir;
}
- /**
- * @see org.apache.maven.reporting.AbstractMavenReport#setReportOutputDirectory(java.io.File)
- */
+ @Override
public void setReportOutputDirectory( File reportOutputDirectory )
{
if ( ( reportOutputDirectory != null ) && ( !reportOutputDirectory.getAbsolutePath().endsWith( "xref" ) ) )
diff --git a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrTestReport.java b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrTestReport.java
index 3418f85..062d2e9 100644
--- a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrTestReport.java
+++ b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrTestReport.java
@@ -61,9 +61,7 @@ public class JxrTestReport
@Parameter( defaultValue = "${project.reporting.outputDirectory}/testapidocs" )
private File testJavadocDir;
- /**
- * @see org.apache.maven.plugin.jxr.AbstractJxrReport#getSourceRoots()
- */
+ @Override
protected List<String> getSourceRoots()
{
List<String> l = new ArrayList<String>();
@@ -84,9 +82,7 @@ public class JxrTestReport
return l;
}
- /**
- * @see org.apache.maven.plugin.jxr.AbstractJxrReport#getSourceRoots(org.apache.maven.project.MavenProject)
- */
+ @Override
protected List<String> getSourceRoots( MavenProject project )
{
List<String> l = new ArrayList<String>();
@@ -102,49 +98,37 @@ public class JxrTestReport
return l;
}
- /**
- * @see org.apache.maven.plugin.jxr.AbstractJxrReport#getDestinationDirectory()
- */
+ @Override
protected String getDestinationDirectory()
{
return destDir;
}
- /**
- * @see org.apache.maven.reporting.MavenReport#getDescription(java.util.Locale)
- */
+ @Override
public String getDescription( Locale locale )
{
return getBundle( locale ).getString( "report.xref.test.description" );
}
- /**
- * @see org.apache.maven.reporting.MavenReport#getName(java.util.Locale)
- */
+ @Override
public String getName( Locale locale )
{
return getBundle( locale ).getString( "report.xref.test.name" );
}
- /**
- * @see org.apache.maven.reporting.MavenReport#getOutputName()
- */
+ @Override
public String getOutputName()
{
return "xref-test/index";
}
- /**
- * @see org.apache.maven.plugin.jxr.AbstractJxrReport#getJavadocDir()
- */
+ @Override
protected File getJavadocDir()
{
return testJavadocDir;
}
- /**
- * @see org.apache.maven.reporting.AbstractMavenReport#setReportOutputDirectory(java.io.File)
- */
+ @Override
public void setReportOutputDirectory( File reportOutputDirectory )
{
if ( ( reportOutputDirectory != null ) && ( !reportOutputDirectory.getAbsolutePath().endsWith( "xref-test" ) ) )
diff --git a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/PluginLogAdapter.java b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/PluginLogAdapter.java
index bb8ce58..d0713a2 100644
--- a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/PluginLogAdapter.java
+++ b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/PluginLogAdapter.java
@@ -42,33 +42,25 @@ public class PluginLogAdapter
this.log = log;
}
- /**
- * @see org.apache.maven.jxr.log.Log#info(String)
- */
+ @Override
public void info( String string )
{
log.info( string );
}
- /**
- * @see org.apache.maven.jxr.log.Log#debug(String)
- */
+ @Override
public void debug( String string )
{
log.debug( string );
}
- /**
- * @see org.apache.maven.jxr.log.Log#warn(String)
- */
+ @Override
public void warn( String string )
{
log.warn( string );
}
- /**
- * @see org.apache.maven.jxr.log.Log#error(String)
- */
+ @Override
public void error( String string )
{
log.error( string );
diff --git a/maven-jxr/src/main/java/org/apache/maven/jxr/ant/DirectoryScanner.java b/maven-jxr/src/main/java/org/apache/maven/jxr/ant/DirectoryScanner.java
index 8ab5826..d1380a9 100644
--- a/maven-jxr/src/main/java/org/apache/maven/jxr/ant/DirectoryScanner.java
+++ b/maven-jxr/src/main/java/org/apache/maven/jxr/ant/DirectoryScanner.java
@@ -30,6 +30,7 @@ public class DirectoryScanner
extends org.codehaus.plexus.util.DirectoryScanner
{
+ @Override
public void addDefaultExcludes()
{
super.addDefaultExcludes();
diff --git a/maven-jxr/src/main/java/org/apache/maven/jxr/log/VelocityLogger.java b/maven-jxr/src/main/java/org/apache/maven/jxr/log/VelocityLogger.java
index 522d1b2..774caab 100644
--- a/maven-jxr/src/main/java/org/apache/maven/jxr/log/VelocityLogger.java
+++ b/maven-jxr/src/main/java/org/apache/maven/jxr/log/VelocityLogger.java
@@ -33,11 +33,13 @@ public class VelocityLogger
{
private Log log;
+ @Override
public void init( RuntimeServices runtimeServices )
{
log = (Log) runtimeServices.getProperty( Log.class.getName() );
}
+ @Override
public void logVelocityMessage( int level, String msg )
{
switch ( level )
diff --git a/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/ClassType.java b/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/ClassType.java
index be09d57..e5783fd 100644
--- a/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/ClassType.java
+++ b/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/ClassType.java
@@ -38,6 +38,7 @@ public class ClassType
* @deprecated Please use {@link #ClassType( String, String )} instead
* @param name
*/
+ @Deprecated
public ClassType( String name )
{
this.setName( name );
diff --git a/maven-jxr/src/main/java/org/apache/maven/jxr/util/StringEntry.java b/maven-jxr/src/main/java/org/apache/maven/jxr/util/StringEntry.java
index daf46ae..67a76f5 100644
--- a/maven-jxr/src/main/java/org/apache/maven/jxr/util/StringEntry.java
+++ b/maven-jxr/src/main/java/org/apache/maven/jxr/util/StringEntry.java
@@ -55,6 +55,7 @@ public class StringEntry
/**
* Description of the Method
*/
+ @Override
public String toString()
{
return this.value;
@@ -63,6 +64,7 @@ public class StringEntry
/**
* Compare two objects for equality.
*/
+ @Override
public int compareTo( StringEntry se )
{
//right now only sort by the index.