You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2022/08/20 09:13:08 UTC
[maven-dist-tool] 04/07: run javadoc:fix to clean up warnings noises
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-dist-tool.git
commit ac22550b9da0e10f7f8ff57dfdce0709f7fca3d6
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Sat Aug 20 10:18:08 2022 +0200
run javadoc:fix to clean up warnings noises
---
.../maven/dist/tools/AbstractCheckResult.java | 11 +++
.../maven/dist/tools/AbstractDistCheckReport.java | 33 ++++++-
.../maven/dist/tools/ConfigurationLineInfo.java | 76 +++++++++++++++
.../maven/dist/tools/DistCheckErrorsReport.java | 19 ++++
.../maven/dist/tools/DummyFailureReport.java | 16 +++
.../org/apache/maven/dist/tools/JsoupRetry.java | 16 +++
.../dist/tools/branches/ListBranchesReport.java | 19 +++-
.../apache/maven/dist/tools/branches/Result.java | 108 ++++++++++++++++++++-
.../dist/tools/index/DistCheckIndexPageReport.java | 15 +++
.../tools/masterjobs/ListMasterJobsReport.java | 12 ++-
.../apache/maven/dist/tools/masterjobs/Result.java | 48 ++++++++-
.../dist/tools/memorycheck/MemoryCheckReport.java | 16 +++
.../maven/dist/tools/pgp/CheckPgpKeysReport.java | 16 +++
.../dist/tools/prerequisites/GetPrerequisites.java | 33 ++++++-
.../ListPluginsPrerequisitesReport.java | 13 +++
.../tools/prerequisites/PluginPrerequisites.java | 52 +++++++++-
.../maven/dist/tools/site/CheckSiteResult.java | 8 +-
.../maven/dist/tools/site/DistCheckSiteReport.java | 19 ++++
.../apache/maven/dist/tools/site/HTMLChecker.java | 3 +-
.../maven/dist/tools/site/HTMLCheckerFactory.java | 2 +
.../tools/site/checkers/FluidoHTMLChecker.java | 11 ++-
.../tools/site/checkers/StylusLeftHTMLChecker.java | 11 ++-
.../site/checkers/StylusRightHTMLChecker.java | 11 ++-
.../tools/source/DistCheckSourceReleaseReport.java | 18 ++++
.../maven/dist/tools/site/SiteReportTest.java | 21 +++-
.../maven/dist/tools/source/PatternTest.java | 9 +-
26 files changed, 600 insertions(+), 16 deletions(-)
diff --git a/src/main/java/org/apache/maven/dist/tools/AbstractCheckResult.java b/src/main/java/org/apache/maven/dist/tools/AbstractCheckResult.java
index ed729ae..77c10c9 100644
--- a/src/main/java/org/apache/maven/dist/tools/AbstractCheckResult.java
+++ b/src/main/java/org/apache/maven/dist/tools/AbstractCheckResult.java
@@ -20,6 +20,7 @@ package org.apache.maven.dist.tools;
*/
/**
+ * <p>AbstractCheckResult class.</p>
*
* @author skygo
*/
@@ -29,6 +30,12 @@ public class AbstractCheckResult
private final ConfigurationLineInfo configLine;
private final String version;
+ /**
+ * <p>Constructor for AbstractCheckResult.</p>
+ *
+ * @param r a {@link org.apache.maven.dist.tools.ConfigurationLineInfo} object
+ * @param version a {@link java.lang.String} object
+ */
public AbstractCheckResult( ConfigurationLineInfo r, String version )
{
this.configLine = r;
@@ -36,6 +43,8 @@ public class AbstractCheckResult
}
/**
+ * <p>getConfigurationLine.</p>
+ *
* @return the request
*/
public ConfigurationLineInfo getConfigurationLine()
@@ -44,6 +53,8 @@ public class AbstractCheckResult
}
/**
+ * <p>Getter for the field <code>version</code>.</p>
+ *
* @return the version
*/
public String getVersion()
diff --git a/src/main/java/org/apache/maven/dist/tools/AbstractDistCheckReport.java b/src/main/java/org/apache/maven/dist/tools/AbstractDistCheckReport.java
index 24ea82e..9ce37cc 100644
--- a/src/main/java/org/apache/maven/dist/tools/AbstractDistCheckReport.java
+++ b/src/main/java/org/apache/maven/dist/tools/AbstractDistCheckReport.java
@@ -51,6 +51,7 @@ import org.apache.maven.reporting.AbstractMavenReport;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
/**
+ * Abstract AbstractDistCheckReport class.
*
* @author skygo
*/
@@ -61,6 +62,13 @@ public abstract class AbstractDistCheckReport
private static final String EOL = System.getProperty( "line.separator" );
+ /**
+ * Abstract Dist Check Report.
+ */
+ public AbstractDistCheckReport()
+ {
+ }
+
/**
* URL of repository where artifacts are stored.
*/
@@ -73,6 +81,9 @@ public abstract class AbstractDistCheckReport
@Parameter( property = "configurationLines", defaultValue = "" )
private List<String> configurationLines;
+ /**
+ * Failures directory.
+ */
@Parameter( defaultValue = "${project.build.directory}/dist-tool" )
protected File failuresDirectory;
@@ -81,6 +92,9 @@ public abstract class AbstractDistCheckReport
*/
protected List<ArtifactRepository> artifactRepositories = new LinkedList<>();
+ /**
+ * Location of distribution area
+ */
protected String distributionAreaUrl;
/**
@@ -102,15 +116,29 @@ public abstract class AbstractDistCheckReport
* is it index page check mojo?
* necessary to only check index page information for plugins marked with asterisk * in db,
* because they are released as part of a global component (archetype, scm, release, ...)
+ *
* @return if it is a index page check.
*/
protected abstract boolean isIndexPageCheck();
+ /**
+ * <p>checkArtifact.</p>
+ *
+ * @param request a {@link org.apache.maven.dist.tools.ConfigurationLineInfo} object
+ * @param repoBase a {@link java.lang.String} object
+ * @throws org.apache.maven.plugin.MojoExecutionException if any.
+ */
protected abstract void checkArtifact( ConfigurationLineInfo request, String repoBase )
throws MojoExecutionException;
+ /**
+ * <p>getFailuresFilename.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
protected abstract String getFailuresFilename();
+ /** {@inheritDoc} */
@Override
public String getOutputName()
{
@@ -141,6 +169,7 @@ public abstract class AbstractDistCheckReport
ArtifactRepositoryPolicy.CHECKSUM_POLICY_WARN );
}
+ /** {@inheritDoc} */
@Override
public void execute()
throws MojoExecutionException
@@ -386,8 +415,8 @@ public abstract class AbstractDistCheckReport
/**
* Log and add Error line to logs.txt if not configured to ignore the artifact+version
- *
- * @param cli {@link ConfigurationLineInfo}
+ *
+ * @param cli {@link org.apache.maven.dist.tools.ConfigurationLineInfo}
* @param version The version.
* @param ignore the list of ignores.
* @param message The message.
diff --git a/src/main/java/org/apache/maven/dist/tools/ConfigurationLineInfo.java b/src/main/java/org/apache/maven/dist/tools/ConfigurationLineInfo.java
index 05966dc..5d7a458 100644
--- a/src/main/java/org/apache/maven/dist/tools/ConfigurationLineInfo.java
+++ b/src/main/java/org/apache/maven/dist/tools/ConfigurationLineInfo.java
@@ -28,6 +28,7 @@ import org.apache.maven.artifact.versioning.VersionRange;
import org.apache.maven.dist.tools.index.DistCheckIndexPageReport;
/**
+ * <p>ConfigurationLineInfo class.</p>
*
* @author skygo
*/
@@ -47,6 +48,11 @@ public class ConfigurationLineInfo
private String indexPageUrl;
private Metadata metadata;
+ /**
+ * <p>Constructor for ConfigurationLineInfo.</p>
+ *
+ * @param infos an array of {@link java.lang.String} objects
+ */
public ConfigurationLineInfo( String[] infos )
{
this.directory = infos[0].replace( '/', ' ' ).replace( ':', ' ' ).trim();
@@ -61,6 +67,13 @@ public class ConfigurationLineInfo
this.indexPageUrl = DistCheckIndexPageReport.POMS_INDEX_URL; // in case of group parent pom artifact
}
+ /**
+ * <p>Constructor for ConfigurationLineInfo.</p>
+ *
+ * @param group a {@link org.apache.maven.dist.tools.ConfigurationLineInfo} object
+ * @param infos an array of {@link java.lang.String} objects
+ * @throws org.apache.maven.artifact.versioning.InvalidVersionSpecificationException if any.
+ */
public ConfigurationLineInfo( ConfigurationLineInfo group, String[] infos )
throws InvalidVersionSpecificationException
{
@@ -74,27 +87,49 @@ public class ConfigurationLineInfo
this.indexPageUrl = group.groupIndexPageUrl;
}
+ /**
+ * <p>Getter for the field <code>indexPageUrl</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getIndexPageUrl()
{
return indexPageUrl;
}
+ /**
+ * <p>getForcedVersion.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getForcedVersion()
{
return forceVersion;
}
+ /**
+ * <p>Setter for the field <code>forceVersion</code>.</p>
+ *
+ * @param forceVersion a {@link java.lang.String} object
+ */
public void setForceVersion( String forceVersion )
{
this.forceVersion = forceVersion;
}
+ /**
+ * <p>Getter for the field <code>versionRange</code>.</p>
+ *
+ * @return a {@link org.apache.maven.artifact.versioning.VersionRange} object
+ */
public VersionRange getVersionRange()
{
return versionRange;
}
/**
+ * <p>Getter for the field <code>groupId</code>.</p>
+ *
* @return the groupId
*/
public String getGroupId()
@@ -103,6 +138,8 @@ public class ConfigurationLineInfo
}
/**
+ * <p>Getter for the field <code>artifactId</code>.</p>
+ *
* @return the artifactId
*/
public String getArtifactId()
@@ -111,6 +148,8 @@ public class ConfigurationLineInfo
}
/**
+ * <p>Getter for the field <code>directory</code>.</p>
+ *
* @return the directory
*/
public String getDirectory()
@@ -118,21 +157,46 @@ public class ConfigurationLineInfo
return directory;
}
+ /**
+ * <p>isSrcBin.</p>
+ *
+ * @return a boolean
+ */
public boolean isSrcBin()
{
return srcBin;
}
+ /**
+ * <p>getBaseURL.</p>
+ *
+ * @param repoBaseUrl a {@link java.lang.String} object
+ * @param folder a {@link java.lang.String} object
+ * @return a {@link java.lang.String} object
+ */
public String getBaseURL( String repoBaseUrl, String folder )
{
return repoBaseUrl + groupId.replaceAll( "\\.", URLSEP ) + URLSEP + artifactId + URLSEP + folder;
}
+ /**
+ * <p>getMetadataFileURL.</p>
+ *
+ * @param repoBaseUrl a {@link java.lang.String} object
+ * @return a {@link java.lang.String} object
+ */
public String getMetadataFileURL( String repoBaseUrl )
{
return getBaseURL( repoBaseUrl, "maven-metadata.xml" );
}
+ /**
+ * <p>getVersionnedFolderURL.</p>
+ *
+ * @param repoBaseUrl a {@link java.lang.String} object
+ * @param version a {@link java.lang.String} object
+ * @return a {@link java.lang.String} object
+ */
public String getVersionnedFolderURL( String repoBaseUrl, String version )
{
return getBaseURL( repoBaseUrl, version ) + '/';
@@ -148,6 +212,11 @@ public class ConfigurationLineInfo
this.metadata = aMetadata;
}
+ /**
+ * <p>getReleaseDateFromMetadata.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getReleaseDateFromMetadata()
{
DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern( "yyyyMMddkkmmss" );
@@ -157,6 +226,13 @@ public class ConfigurationLineInfo
return DateTimeFormatter.ISO_LOCAL_DATE.format( ta );
}
+ /**
+ * <p>getSourceReleaseFilename.</p>
+ *
+ * @param version a {@link java.lang.String} object
+ * @param dist a boolean
+ * @return a {@link java.lang.String} object
+ */
public String getSourceReleaseFilename( String version, boolean dist )
{
return artifactId + "-" + version
diff --git a/src/main/java/org/apache/maven/dist/tools/DistCheckErrorsReport.java b/src/main/java/org/apache/maven/dist/tools/DistCheckErrorsReport.java
index be84000..d3385d4 100644
--- a/src/main/java/org/apache/maven/dist/tools/DistCheckErrorsReport.java
+++ b/src/main/java/org/apache/maven/dist/tools/DistCheckErrorsReport.java
@@ -34,6 +34,7 @@ import org.apache.maven.reporting.MavenReportException;
import org.codehaus.plexus.util.FileUtils;
/**
+ * <p>DistCheckErrorsReport class.</p>
*
* @author skygo
*/
@@ -47,6 +48,14 @@ public class DistCheckErrorsReport
private static final String EOL = System.getProperty( "line.separator" );
+ /**
+ * Dist Check Errors Report.
+ */
+ public DistCheckErrorsReport()
+ {
+ }
+
+ /** {@inheritDoc} */
@Override
protected boolean isIndexPageCheck()
{
@@ -97,6 +106,7 @@ public class DistCheckErrorsReport
}
}
+ /** {@inheritDoc} */
@Override
protected void executeReport( Locale locale )
throws MavenReportException
@@ -126,29 +136,38 @@ public class DistCheckErrorsReport
}
}
+ /**
+ * <p>getFailuresFilename.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
protected String getFailuresFilename()
{
return "dummy";
}
+ /** {@inheritDoc} */
@Override
public String getOutputName()
{
return "dist-tool-check-errors";
}
+ /** {@inheritDoc} */
@Override
public String getName( Locale locale )
{
return "Dist Tool> Check Errors";
}
+ /** {@inheritDoc} */
@Override
public String getDescription( Locale locale )
{
return "Dist Tool report to display inconsistencies found by any check report";
}
+ /** {@inheritDoc} */
@Override
protected void checkArtifact( ConfigurationLineInfo request, String repoBase )
throws MojoExecutionException
diff --git a/src/main/java/org/apache/maven/dist/tools/DummyFailureReport.java b/src/main/java/org/apache/maven/dist/tools/DummyFailureReport.java
index bc61d54..c9453d1 100644
--- a/src/main/java/org/apache/maven/dist/tools/DummyFailureReport.java
+++ b/src/main/java/org/apache/maven/dist/tools/DummyFailureReport.java
@@ -24,6 +24,7 @@ import java.util.Locale;
import org.apache.maven.plugins.annotations.Mojo;
/**
+ * <p>DummyFailureReport class.</p>
*
* @author skygo
*/
@@ -31,29 +32,44 @@ import org.apache.maven.plugins.annotations.Mojo;
public class DummyFailureReport
extends DistCheckErrorsReport
{
+ /**
+ * Dummy
+ */
+ public DummyFailureReport()
+ {
+ }
+
@Override
boolean isDummyFailure()
{
return true;
}
+ /**
+ * <p>getFailuresFilename.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
protected String getFailuresFilename()
{
return "dummy";
}
+ /** {@inheritDoc} */
@Override
public String getOutputName()
{
return "dist-tool-failure";
}
+ /** {@inheritDoc} */
@Override
public String getName( Locale locale )
{
return "Dist Tool> Failure Hack";
}
+ /** {@inheritDoc} */
@Override
public String getDescription( Locale locale )
{
diff --git a/src/main/java/org/apache/maven/dist/tools/JsoupRetry.java b/src/main/java/org/apache/maven/dist/tools/JsoupRetry.java
index 62e214b..df6f255 100644
--- a/src/main/java/org/apache/maven/dist/tools/JsoupRetry.java
+++ b/src/main/java/org/apache/maven/dist/tools/JsoupRetry.java
@@ -29,10 +29,26 @@ import org.jsoup.nodes.Document;
*/
public class JsoupRetry
{
+ /** Constant <code>MAX_RETRY=3</code> */
public static final int MAX_RETRY = 3;
+ /** Constant <code>WAIT_RETRY_SECONDS=10</code> */
public static final int WAIT_RETRY_SECONDS = 10;
+ /**
+ * JsoupRetry constructor.
+ */
+ public JsoupRetry()
+ {
+ }
+
+ /**
+ * <p>get.</p>
+ *
+ * @param url a {@link java.lang.String} object
+ * @return a {@link org.jsoup.nodes.Document} object
+ * @throws java.io.IOException if any.
+ */
public static Document get( String url )
throws IOException
{
diff --git a/src/main/java/org/apache/maven/dist/tools/branches/ListBranchesReport.java b/src/main/java/org/apache/maven/dist/tools/branches/ListBranchesReport.java
index 2e7e2b1..e60b656 100644
--- a/src/main/java/org/apache/maven/dist/tools/branches/ListBranchesReport.java
+++ b/src/main/java/org/apache/maven/dist/tools/branches/ListBranchesReport.java
@@ -172,25 +172,35 @@ public class ListBranchesReport extends AbstractMavenReport
JIRAPROJECTS.put( "maven-wrapper", "MWRAPPER" );
}
+ /**
+ * List Branches Constructor.
+ */
+ public ListBranchesReport()
+ {
+ }
+ /** {@inheritDoc} */
@Override
public String getOutputName()
{
return "dist-tool-branches";
}
+ /** {@inheritDoc} */
@Override
public String getName( Locale locale )
{
return "Dist Tool> List Branches";
}
+ /** {@inheritDoc} */
@Override
public String getDescription( Locale locale )
{
return "Shows the list of branches of every Git repository on one page";
}
+ /** {@inheritDoc} */
@Override
protected void executeReport( Locale locale )
throws MavenReportException
@@ -549,7 +559,7 @@ public class ListBranchesReport extends AbstractMavenReport
* <a href="https://gitbox.apache.org/repos/asf">Gitbox main page</a>.
*
* @return the list of repository names (without ".git")
- * @throws IOException problem with reading repository index
+ * @throws java.io.IOException problem with reading repository index
*/
protected Collection<String> repositoryNames()
throws IOException
@@ -569,6 +579,13 @@ public class ListBranchesReport extends AbstractMavenReport
return names;
}
+ /**
+ * <p>hasDependabotYml.</p>
+ *
+ * @param repositoryName a {@link java.lang.String} object
+ * @return a boolean
+ * @throws java.io.IOException if any.
+ */
protected static boolean hasDependabotYml( String repositoryName )
throws IOException
{
diff --git a/src/main/java/org/apache/maven/dist/tools/branches/Result.java b/src/main/java/org/apache/maven/dist/tools/branches/Result.java
index b8f722d..c6e44c4 100644
--- a/src/main/java/org/apache/maven/dist/tools/branches/Result.java
+++ b/src/main/java/org/apache/maven/dist/tools/branches/Result.java
@@ -23,7 +23,7 @@ import java.util.Collection;
/**
* Represent build result of a Jenkins job for a Git master branch.
- *
+ *
* @author Robert Scholte
*/
public class Result
@@ -44,107 +44,213 @@ public class Result
private Collection<String> restGit;
private Collection<String> restJenkins;
+ /**
+ * <p>Constructor for Result.</p>
+ *
+ * @param repositoryName a {@link java.lang.String} object
+ * @param buildUrl a {@link java.lang.String} object
+ */
public Result( String repositoryName, String buildUrl )
{
this.repositoryName = repositoryName;
this.buildUrl = buildUrl;
}
+ /**
+ * <p>Getter for the field <code>masterBranchesGit</code>.</p>
+ *
+ * @return a int
+ */
public int getMasterBranchesGit()
{
return masterBranchesGit;
}
+ /**
+ * <p>Setter for the field <code>masterBranchesGit</code>.</p>
+ *
+ * @param masterBranches a int
+ */
public void setMasterBranchesGit( int masterBranches )
{
this.masterBranchesGit = masterBranches;
}
+ /**
+ * <p>Getter for the field <code>masterBranchesJenkins</code>.</p>
+ *
+ * @return a int
+ */
public int getMasterBranchesJenkins()
{
return masterBranchesJenkins;
}
+ /**
+ * <p>Setter for the field <code>masterBranchesJenkins</code>.</p>
+ *
+ * @param masterBranchesJenkins a int
+ */
public void setMasterBranchesJenkins( int masterBranchesJenkins )
{
this.masterBranchesJenkins = masterBranchesJenkins;
}
+ /**
+ * <p>Getter for the field <code>jiraBranchesGit</code>.</p>
+ *
+ * @return a {@link java.util.Collection} object
+ */
public Collection<String> getJiraBranchesGit()
{
return jiraBranchesGit;
}
+ /**
+ * <p>Setter for the field <code>jiraBranchesGit</code>.</p>
+ *
+ * @param jiraBranches a {@link java.util.Collection} object
+ */
public void setJiraBranchesGit( Collection<String> jiraBranches )
{
this.jiraBranchesGit = jiraBranches;
}
+ /**
+ * <p>Getter for the field <code>jiraBranchesJenkins</code>.</p>
+ *
+ * @return a {@link java.util.Collection} object
+ */
public Collection<String> getJiraBranchesJenkins()
{
return jiraBranchesJenkins;
}
+ /**
+ * <p>Setter for the field <code>jiraBranchesJenkins</code>.</p>
+ *
+ * @param jiraBranchesJenkins a {@link java.util.Collection} object
+ */
public void setJiraBranchesJenkins( Collection<String> jiraBranchesJenkins )
{
this.jiraBranchesJenkins = jiraBranchesJenkins;
}
+ /**
+ * <p>Getter for the field <code>dependabotBranchesGit</code>.</p>
+ *
+ * @return a {@link java.util.Collection} object
+ */
public Collection<String> getDependabotBranchesGit()
{
return dependabotBranchesGit;
}
+ /**
+ * <p>Setter for the field <code>dependabotBranchesGit</code>.</p>
+ *
+ * @param dependabotBranches a {@link java.util.Collection} object
+ */
public void setDependabotBranchesGit( Collection<String> dependabotBranches )
{
this.dependabotBranchesGit = dependabotBranches;
}
+ /**
+ * <p>Getter for the field <code>dependabotBranchesJenkins</code>.</p>
+ *
+ * @return a {@link java.util.Collection} object
+ */
public Collection<String> getDependabotBranchesJenkins()
{
return dependabotBranchesJenkins;
}
+ /**
+ * <p>Setter for the field <code>dependabotBranchesJenkins</code>.</p>
+ *
+ * @param dependabotBranchesJenkins a {@link java.util.Collection} object
+ */
public void setDependabotBranchesJenkins( Collection<String> dependabotBranchesJenkins )
{
this.dependabotBranchesJenkins = dependabotBranchesJenkins;
}
+ /**
+ * <p>Getter for the field <code>restGit</code>.</p>
+ *
+ * @return a {@link java.util.Collection} object
+ */
public Collection<String> getRestGit()
{
return restGit;
}
+ /**
+ * <p>Setter for the field <code>restGit</code>.</p>
+ *
+ * @param rest a {@link java.util.Collection} object
+ */
public void setRestGit( Collection<String> rest )
{
this.restGit = rest;
}
+ /**
+ * <p>Getter for the field <code>restJenkins</code>.</p>
+ *
+ * @return a {@link java.util.Collection} object
+ */
public Collection<String> getRestJenkins()
{
return restJenkins;
}
+ /**
+ * <p>Setter for the field <code>restJenkins</code>.</p>
+ *
+ * @param restJenkins a {@link java.util.Collection} object
+ */
public void setRestJenkins( Collection<String> restJenkins )
{
this.restJenkins = restJenkins;
}
+ /**
+ * <p>Getter for the field <code>repositoryName</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getRepositoryName()
{
return repositoryName;
}
+ /**
+ * <p>Getter for the field <code>buildUrl</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getBuildUrl()
{
return buildUrl;
}
+ /**
+ * <p>getTotalGit.</p>
+ *
+ * @return a int
+ */
public final int getTotalGit()
{
return masterBranchesGit + jiraBranchesGit.size() + dependabotBranchesGit.size() + restGit.size();
}
+ /**
+ * <p>getTotalJenkins.</p>
+ *
+ * @return a int
+ */
public final int getTotalJenkins()
{
return masterBranchesJenkins + jiraBranchesJenkins.size() + dependabotBranchesJenkins.size()
diff --git a/src/main/java/org/apache/maven/dist/tools/index/DistCheckIndexPageReport.java b/src/main/java/org/apache/maven/dist/tools/index/DistCheckIndexPageReport.java
index be7307c..d7f743d 100644
--- a/src/main/java/org/apache/maven/dist/tools/index/DistCheckIndexPageReport.java
+++ b/src/main/java/org/apache/maven/dist/tools/index/DistCheckIndexPageReport.java
@@ -51,8 +51,10 @@ import org.jsoup.select.Elements;
public class DistCheckIndexPageReport
extends AbstractDistCheckReport
{
+ /** Constant <code>FAILURES_FILENAME="check-index-page.log"</code> */
public static final String FAILURES_FILENAME = "check-index-page.log";
+ /** Constant <code>POMS_INDEX_URL="<a href="https://maven.apache.org/pom/">...</a>"</code> */
public static final String POMS_INDEX_URL = "https://maven.apache.org/pom/";
private static final IndexPage[] INDEX_PAGES = new IndexPage[] {
@@ -73,30 +75,41 @@ public class DistCheckIndexPageReport
INDEX_PAGES_REF = Collections.unmodifiableMap( aMap );
}
+ /**
+ * Dist Check Index Page Report.
+ */
+ public DistCheckIndexPageReport()
+ {
+ }
+
/**
* Ignore dist failure for <code>artifactId</code> or <code>artifactId:version</code>
*/
@Parameter
protected List<String> ignoreDistFailures;
+ /** {@inheritDoc} */
@Override
protected String getFailuresFilename()
{
return FAILURES_FILENAME;
}
+ /** {@inheritDoc} */
@Override
public String getName( Locale locale )
{
return "Dist Tool> Check Index Pages";
}
+ /** {@inheritDoc} */
@Override
public String getDescription( Locale locale )
{
return "Verification of index pages";
}
+ /** {@inheritDoc} */
@Override
protected boolean isIndexPageCheck()
{
@@ -191,6 +204,7 @@ public class DistCheckIndexPageReport
return Math.abs( daysDifference ) < 7; // ok for 7 days difference
}
+ /** {@inheritDoc} */
@Override
protected void executeReport( Locale locale )
throws MavenReportException
@@ -314,6 +328,7 @@ public class DistCheckIndexPageReport
}
}
+ /** {@inheritDoc} */
@Override
protected void checkArtifact( ConfigurationLineInfo configLine, String version )
throws MojoExecutionException
diff --git a/src/main/java/org/apache/maven/dist/tools/masterjobs/ListMasterJobsReport.java b/src/main/java/org/apache/maven/dist/tools/masterjobs/ListMasterJobsReport.java
index 18f0dfc..e2d72a2 100644
--- a/src/main/java/org/apache/maven/dist/tools/masterjobs/ListMasterJobsReport.java
+++ b/src/main/java/org/apache/maven/dist/tools/masterjobs/ListMasterJobsReport.java
@@ -62,25 +62,35 @@ public class ListMasterJobsReport extends AbstractMavenReport
"maven-metric-extension",
"maven-gh-actions-shared" );
+ /**
+ * <p>Constructor for DistCheckSiteReport.</p>
+ */
+ public ListMasterJobsReport()
+ {
+ }
+ /** {@inheritDoc} */
@Override
public String getOutputName()
{
return "dist-tool-master-jobs";
}
+ /** {@inheritDoc} */
@Override
public String getName( Locale locale )
{
return "Dist Tool> List Master Jobs";
}
+ /** {@inheritDoc} */
@Override
public String getDescription( Locale locale )
{
return "Shows the status of Jenkins job for the master branch of every Git repository on one page";
}
+ /** {@inheritDoc} */
@Override
protected void executeReport( Locale locale )
throws MavenReportException
@@ -250,7 +260,7 @@ public class ListMasterJobsReport extends AbstractMavenReport
* <a href="https://gitbox.apache.org/repos/asf">Gitbox main page</a>.
*
* @return the list of repository names (without ".git")
- * @throws IOException problem with reading repository index
+ * @throws java.io.IOException problem with reading repository index
*/
protected Collection<String> repositoryNames()
throws IOException
diff --git a/src/main/java/org/apache/maven/dist/tools/masterjobs/Result.java b/src/main/java/org/apache/maven/dist/tools/masterjobs/Result.java
index 898c895..d3d3c83 100644
--- a/src/main/java/org/apache/maven/dist/tools/masterjobs/Result.java
+++ b/src/main/java/org/apache/maven/dist/tools/masterjobs/Result.java
@@ -23,7 +23,7 @@ import java.time.ZonedDateTime;
/**
* Represent build result of a Jenkins job for a Git master branch.
- *
+ *
* @author Robert Scholte
*/
public class Result
@@ -38,47 +38,93 @@ public class Result
private ZonedDateTime lastBuild;
+ /**
+ * <p>Constructor for Result.</p>
+ *
+ * @param repositoryName a {@link java.lang.String} object
+ * @param buildUrl a {@link java.lang.String} object
+ */
public Result( String repositoryName, String buildUrl )
{
this.repositoryName = repositoryName;
this.buildUrl = buildUrl;
}
+ /**
+ * <p>Setter for the field <code>status</code>.</p>
+ *
+ * @param status a {@link java.lang.String} object
+ */
public void setStatus( String status )
{
this.status = status;
}
+ /**
+ * <p>Setter for the field <code>icon</code>.</p>
+ *
+ * @param icon a {@link java.lang.String} object
+ */
public void setIcon( String icon )
{
this.icon = icon;
}
+ /**
+ * <p>Setter for the field <code>lastBuild</code>.</p>
+ *
+ * @param lastBuild a {@link java.time.ZonedDateTime} object
+ */
public void setLastBuild( ZonedDateTime lastBuild )
{
this.lastBuild = lastBuild;
}
+ /**
+ * <p>Getter for the field <code>lastBuild</code>.</p>
+ *
+ * @return a {@link java.time.ZonedDateTime} object
+ */
public ZonedDateTime getLastBuild()
{
return lastBuild;
}
+ /**
+ * <p>Getter for the field <code>repositoryName</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getRepositoryName()
{
return repositoryName;
}
+ /**
+ * <p>Getter for the field <code>status</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getStatus()
{
return status;
}
+ /**
+ * <p>Getter for the field <code>buildUrl</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getBuildUrl()
{
return buildUrl;
}
+ /**
+ * <p>Getter for the field <code>icon</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getIcon()
{
return icon;
diff --git a/src/main/java/org/apache/maven/dist/tools/memorycheck/MemoryCheckReport.java b/src/main/java/org/apache/maven/dist/tools/memorycheck/MemoryCheckReport.java
index 0d1ff70..6bdebb9 100644
--- a/src/main/java/org/apache/maven/dist/tools/memorycheck/MemoryCheckReport.java
+++ b/src/main/java/org/apache/maven/dist/tools/memorycheck/MemoryCheckReport.java
@@ -55,11 +55,21 @@ public class MemoryCheckReport extends AbstractDistCheckReport
{
private static final String GITHUB_REPOSITORY = "quick-perf/maven-test-bench";
+ /** Constant <code>GITHUB_REPOSITORY_URL="<a href="https://github.com/">...</a> + GITHUB_REPOSITORY"</code> */
public static final String GITHUB_REPOSITORY_URL = "https://github.com/" + GITHUB_REPOSITORY;
+ /** Constant <code>MEMORY_CHECK_GITHUB_ACTION_WORKFLOW_NAME="Daily Memory Check"</code> */
public static final String MEMORY_CHECK_GITHUB_ACTION_WORKFLOW_NAME = "Daily Memory Check";
private static final int BUILD_HISTORY_SIZE = 10;
private static final int GITHUB_ACTION_JOB_PAGE_SIZE = 10;
+ /**
+ * Memory Check Report constructor.
+ */
+ public MemoryCheckReport()
+ {
+ }
+
+ /** {@inheritDoc} */
@Override
protected void executeReport( Locale locale ) throws MavenReportException
{
@@ -136,35 +146,41 @@ public class MemoryCheckReport extends AbstractDistCheckReport
sink.list_();
}
+ /** {@inheritDoc} */
@Override
protected boolean isIndexPageCheck()
{
return false;
}
+ /** {@inheritDoc} */
@Override
protected void checkArtifact( ConfigurationLineInfo request, String repoBase ) throws MojoExecutionException
{
}
+ /** {@inheritDoc} */
@Override
protected String getFailuresFilename()
{
return null;
}
+ /** {@inheritDoc} */
@Override
public String getOutputName()
{
return "dist-tool-memory-check";
}
+ /** {@inheritDoc} */
@Override
public String getName( Locale locale )
{
return "Dist Tool> Memory Check";
}
+ /** {@inheritDoc} */
@Override
public String getDescription( Locale locale )
{
diff --git a/src/main/java/org/apache/maven/dist/tools/pgp/CheckPgpKeysReport.java b/src/main/java/org/apache/maven/dist/tools/pgp/CheckPgpKeysReport.java
index 9d8b08f..226723a 100644
--- a/src/main/java/org/apache/maven/dist/tools/pgp/CheckPgpKeysReport.java
+++ b/src/main/java/org/apache/maven/dist/tools/pgp/CheckPgpKeysReport.java
@@ -48,36 +48,51 @@ import static org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics.B
public class CheckPgpKeysReport
extends AbstractDistCheckReport
{
+ /** Constant <code>FAILURES_FILENAME="check-pgp-keys.log"</code> */
public static final String FAILURES_FILENAME = "check-pgp-keys.log";
+ /** Constant <code>PROJECT_KEYS_URL="<a href="https://svn.apache.org/repos/asf/maven/">...</a>"{trunked}</code> */
public static final String PROJECT_KEYS_URL = "https://svn.apache.org/repos/asf/maven/project/KEYS";
+ /** Constant <code>DIST_KEYS_URL="<a href="https://dist.apache.org/repos/dist/rele">...</a>"{trunked}</code> */
public static final String DIST_KEYS_URL = "https://dist.apache.org/repos/dist/release/maven/KEYS";
+ /**
+ * Check PGP Keys report.
+ */
+ public CheckPgpKeysReport()
+ {
+ }
+
+ /** {@inheritDoc} */
@Override
protected String getFailuresFilename()
{
return FAILURES_FILENAME;
}
+ /** {@inheritDoc} */
@Override
public String getName( Locale locale )
{
return "Dist Tool> Check PGP KEYS";
}
+ /** {@inheritDoc} */
@Override
public String getDescription( Locale locale )
{
return "Verification of PGP KEYS files";
}
+ /** {@inheritDoc} */
@Override
protected boolean isIndexPageCheck()
{
return false;
}
+ /** {@inheritDoc} */
@Override
protected void executeReport( Locale locale )
throws MavenReportException
@@ -171,6 +186,7 @@ public class CheckPgpKeysReport
sink.close();
}
+ /** {@inheritDoc} */
@Override
protected void checkArtifact( ConfigurationLineInfo request, String repoBase )
throws MojoExecutionException
diff --git a/src/main/java/org/apache/maven/dist/tools/prerequisites/GetPrerequisites.java b/src/main/java/org/apache/maven/dist/tools/prerequisites/GetPrerequisites.java
index b62d38e..8b40003 100644
--- a/src/main/java/org/apache/maven/dist/tools/prerequisites/GetPrerequisites.java
+++ b/src/main/java/org/apache/maven/dist/tools/prerequisites/GetPrerequisites.java
@@ -32,8 +32,9 @@ import org.jsoup.nodes.Element;
import org.jsoup.select.Elements;
/**
- * @author Karl Heinz Marbaiase
+ * <p>GetPrerequisites class.</p>
*
+ * @author Karl Heinz Marbaiase
*/
public class GetPrerequisites
{
@@ -100,11 +101,31 @@ public class GetPrerequisites
private static final String BASEURL = "https://maven.apache.org/plugins/";
+ /**
+ * Get Prerequisites for the given plugin name.
+ */
+ public GetPrerequisites()
+ {
+ }
+
+ /**
+ * <p>getPluginInfoUrl.</p>
+ *
+ * @param pluginName a {@link java.lang.String} object
+ * @return a {@link java.lang.String} object
+ */
public String getPluginInfoUrl( String pluginName )
{
return BASEURL + pluginName + "/plugin-info.html";
}
+ /**
+ * <p>getPluginPrerequisites.</p>
+ *
+ * @param pluginName a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.dist.tools.prerequisites.PluginPrerequisites} object
+ * @throws java.io.IOException if any.
+ */
public PluginPrerequisites getPluginPrerequisites( String pluginName )
throws IOException
{
@@ -167,6 +188,11 @@ public class GetPrerequisites
return new PluginPrerequisites( pluginName, pluginVersion, releaseDate, mavenVersion, jdkVersion );
}
+ /**
+ * <p>getPrequisites.</p>
+ *
+ * @return a {@link java.util.List} object
+ */
public List<PluginPrerequisites> getPrequisites()
{
List<PluginPrerequisites> result = new ArrayList<>();
@@ -186,6 +212,11 @@ public class GetPrerequisites
return result;
}
+ /**
+ * <p>getGroupedPrequisites.</p>
+ *
+ * @return a {@link java.util.Map} object
+ */
public Map<ArtifactVersion, List<PluginPrerequisites>> getGroupedPrequisites()
{
return getPrequisites().stream()
diff --git a/src/main/java/org/apache/maven/dist/tools/prerequisites/ListPluginsPrerequisitesReport.java b/src/main/java/org/apache/maven/dist/tools/prerequisites/ListPluginsPrerequisitesReport.java
index 64fa845..4e1de48 100644
--- a/src/main/java/org/apache/maven/dist/tools/prerequisites/ListPluginsPrerequisitesReport.java
+++ b/src/main/java/org/apache/maven/dist/tools/prerequisites/ListPluginsPrerequisitesReport.java
@@ -29,24 +29,36 @@ import org.apache.maven.reporting.AbstractMavenReport;
import org.apache.maven.reporting.MavenReportException;
/**
+ * <p>ListPluginsPrerequisitesReport class.</p>
+ *
* @author Karl Heinz Marbaise
*/
@Mojo( name = "list-plugins-prerequisites", requiresProject = false )
public class ListPluginsPrerequisitesReport
extends AbstractMavenReport
{
+ /**
+ * List Plugins Prerequisites Report
+ */
+ public ListPluginsPrerequisitesReport()
+ {
+ }
+
+ /** {@inheritDoc} */
@Override
public String getName( Locale locale )
{
return "Dist Tool> List Plugins Prerequisites";
}
+ /** {@inheritDoc} */
@Override
public String getDescription( Locale locale )
{
return "Maven and JDK version prerequisites for plugins";
}
+ /** {@inheritDoc} */
@Override
protected void executeReport( Locale locale )
throws MavenReportException
@@ -131,6 +143,7 @@ public class ListPluginsPrerequisitesReport
sink.body_();
}
+ /** {@inheritDoc} */
@Override
public String getOutputName()
{
diff --git a/src/main/java/org/apache/maven/dist/tools/prerequisites/PluginPrerequisites.java b/src/main/java/org/apache/maven/dist/tools/prerequisites/PluginPrerequisites.java
index f8f1aac..b349966 100644
--- a/src/main/java/org/apache/maven/dist/tools/prerequisites/PluginPrerequisites.java
+++ b/src/main/java/org/apache/maven/dist/tools/prerequisites/PluginPrerequisites.java
@@ -23,8 +23,9 @@ import org.apache.maven.artifact.versioning.ArtifactVersion;
import org.apache.maven.artifact.versioning.DefaultArtifactVersion;
/**
- * @author Karl Heinz Marbaise
+ * <p>PluginPrerequisites class.</p>
*
+ * @author Karl Heinz Marbaise
*/
public class PluginPrerequisites
{
@@ -38,6 +39,15 @@ public class PluginPrerequisites
private String jdkVersion;
+ /**
+ * <p>Constructor for PluginPrerequisites.</p>
+ *
+ * @param pluginName a {@link java.lang.String} object
+ * @param pluginVersion a {@link java.lang.String} object
+ * @param releaseDate a {@link java.lang.String} object
+ * @param mavenVersion a {@link java.lang.String} object
+ * @param jdkVersion a {@link java.lang.String} object
+ */
public PluginPrerequisites( String pluginName, String pluginVersion, String releaseDate, String mavenVersion,
String jdkVersion )
{
@@ -48,41 +58,81 @@ public class PluginPrerequisites
this.jdkVersion = jdkVersion;
}
+ /**
+ * <p>Getter for the field <code>mavenVersion</code>.</p>
+ *
+ * @return a {@link org.apache.maven.artifact.versioning.ArtifactVersion} object
+ */
public ArtifactVersion getMavenVersion()
{
return mavenVersion;
}
+ /**
+ * <p>Setter for the field <code>mavenVersion</code>.</p>
+ *
+ * @param mavenVersion a {@link java.lang.String} object
+ */
public void setMavenVersion( String mavenVersion )
{
this.mavenVersion = new DefaultArtifactVersion( mavenVersion );
}
+ /**
+ * <p>Getter for the field <code>jdkVersion</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getJdkVersion()
{
return jdkVersion;
}
+ /**
+ * <p>Setter for the field <code>jdkVersion</code>.</p>
+ *
+ * @param jdkVersion a {@link java.lang.String} object
+ */
public void setJdkVersion( String jdkVersion )
{
this.jdkVersion = jdkVersion;
}
+ /**
+ * <p>Getter for the field <code>pluginName</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getPluginName()
{
return pluginName;
}
+ /**
+ * <p>Getter for the field <code>pluginVersion</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getPluginVersion()
{
return pluginVersion;
}
+ /**
+ * <p>Getter for the field <code>releaseDate</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getReleaseDate()
{
return releaseDate;
}
+ /**
+ * <p>Setter for the field <code>pluginName</code>.</p>
+ *
+ * @param pluginName a {@link java.lang.String} object
+ */
public void setPluginName( String pluginName )
{
this.pluginName = pluginName;
diff --git a/src/main/java/org/apache/maven/dist/tools/site/CheckSiteResult.java b/src/main/java/org/apache/maven/dist/tools/site/CheckSiteResult.java
index 00b90eb..3b3f026 100644
--- a/src/main/java/org/apache/maven/dist/tools/site/CheckSiteResult.java
+++ b/src/main/java/org/apache/maven/dist/tools/site/CheckSiteResult.java
@@ -54,6 +54,8 @@ class CheckSiteResult
}
/**
+ * <p>Getter for the field <code>url</code>.</p>
+ *
* @return the url
*/
public String getUrl()
@@ -62,6 +64,8 @@ class CheckSiteResult
}
/**
+ * <p>Getter for the field <code>checkMap</code>.</p>
+ *
* @return the checkMap
*/
public Map<HTMLChecker, Boolean> getCheckMap()
@@ -75,6 +79,8 @@ class CheckSiteResult
}
/**
+ * <p>Getter for the field <code>statusCode</code>.</p>
+ *
* @return the statusCode
*/
public int getStatusCode()
@@ -167,4 +173,4 @@ class CheckSiteResult
{
return screenshotName;
}
-}
\ No newline at end of file
+}
diff --git a/src/main/java/org/apache/maven/dist/tools/site/DistCheckSiteReport.java b/src/main/java/org/apache/maven/dist/tools/site/DistCheckSiteReport.java
index 7fa9a02..8ffa664 100644
--- a/src/main/java/org/apache/maven/dist/tools/site/DistCheckSiteReport.java
+++ b/src/main/java/org/apache/maven/dist/tools/site/DistCheckSiteReport.java
@@ -41,6 +41,7 @@ import org.jsoup.HttpStatusException;
import org.jsoup.nodes.Document;
/**
+ * <p>DistCheckSiteReport class.</p>
*
* @author skygo
*/
@@ -48,8 +49,16 @@ import org.jsoup.nodes.Document;
public class DistCheckSiteReport
extends AbstractDistCheckReport
{
+ /** Constant <code>FAILURES_FILENAME="check-site.log"</code> */
public static final String FAILURES_FILENAME = "check-site.log";
+ /**
+ * <p>Constructor for DistCheckSiteReport.</p>
+ */
+ public DistCheckSiteReport()
+ {
+ }
+
/**
* Ignore site failure for <code>artifactId</code> or <code>artifactId:version</code>
*/
@@ -79,23 +88,31 @@ public class DistCheckSiteReport
*/
protected static final int HTTP_OK = 200;
+ /** {@inheritDoc} */
@Override
protected boolean isIndexPageCheck()
{
return false;
}
+ /**
+ * <p>getFailuresFilename.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
protected String getFailuresFilename()
{
return FAILURES_FILENAME;
}
+ /** {@inheritDoc} */
@Override
public String getName( Locale locale )
{
return "Dist Tool> Check Sites";
}
+ /** {@inheritDoc} */
@Override
public String getDescription( Locale locale )
{
@@ -106,6 +123,7 @@ public class DistCheckSiteReport
private List<CheckSiteResult> results = new LinkedList<>();
private final List<HTMLChecker> checkers = HTMLCheckerFactory.getCheckers();
+ /** {@inheritDoc} */
@Override
protected void executeReport( Locale locale )
throws MavenReportException
@@ -272,6 +290,7 @@ public class DistCheckSiteReport
}
+ /** {@inheritDoc} */
@Override
protected void checkArtifact( ConfigurationLineInfo configLine, String latestVersion )
throws MojoExecutionException
diff --git a/src/main/java/org/apache/maven/dist/tools/site/HTMLChecker.java b/src/main/java/org/apache/maven/dist/tools/site/HTMLChecker.java
index fc66a63..62875dd 100644
--- a/src/main/java/org/apache/maven/dist/tools/site/HTMLChecker.java
+++ b/src/main/java/org/apache/maven/dist/tools/site/HTMLChecker.java
@@ -22,6 +22,7 @@ package org.apache.maven.dist.tools.site;
import org.jsoup.nodes.Document;
/**
+ * <p>HTMLChecker interface.</p>
*
* @author skygo
*/
@@ -37,7 +38,7 @@ public interface HTMLChecker
/**
* Get an id representing skin.
- *
+ *
* @return string for skin
*/
String getSkin();
diff --git a/src/main/java/org/apache/maven/dist/tools/site/HTMLCheckerFactory.java b/src/main/java/org/apache/maven/dist/tools/site/HTMLCheckerFactory.java
index def496d..7180625 100644
--- a/src/main/java/org/apache/maven/dist/tools/site/HTMLCheckerFactory.java
+++ b/src/main/java/org/apache/maven/dist/tools/site/HTMLCheckerFactory.java
@@ -27,6 +27,7 @@ import org.apache.maven.dist.tools.site.checkers.StylusLeftHTMLChecker;
import org.apache.maven.dist.tools.site.checkers.StylusRightHTMLChecker;
/**
+ * <p>HTMLCheckerFactory class.</p>
*
* @author skygo
*/
@@ -39,6 +40,7 @@ public final class HTMLCheckerFactory
/**
* get all checker
+ *
* @return list of checker
*/
public static List<HTMLChecker> getCheckers()
diff --git a/src/main/java/org/apache/maven/dist/tools/site/checkers/FluidoHTMLChecker.java b/src/main/java/org/apache/maven/dist/tools/site/checkers/FluidoHTMLChecker.java
index 2ae7d5c..7daeb76 100644
--- a/src/main/java/org/apache/maven/dist/tools/site/checkers/FluidoHTMLChecker.java
+++ b/src/main/java/org/apache/maven/dist/tools/site/checkers/FluidoHTMLChecker.java
@@ -25,24 +25,33 @@ import org.jsoup.nodes.Element;
/**
* Check if artifact version is present in fluido skin.
- *
+ *
* @author skygo
*/
public class FluidoHTMLChecker implements HTMLChecker
{
+ /**
+ * Fluido Html Checker
+ */
+ public FluidoHTMLChecker()
+ {
+ }
+ /** {@inheritDoc} */
@Override
public String getName()
{
return "Fluido";
}
+ /** {@inheritDoc} */
@Override
public String getSkin()
{
return "Fluido";
}
+ /** {@inheritDoc} */
@Override
public boolean isDisplayedArtifactVersionOk( Document doc, String version )
{
diff --git a/src/main/java/org/apache/maven/dist/tools/site/checkers/StylusLeftHTMLChecker.java b/src/main/java/org/apache/maven/dist/tools/site/checkers/StylusLeftHTMLChecker.java
index 4d2cc50..d0f69c0 100644
--- a/src/main/java/org/apache/maven/dist/tools/site/checkers/StylusLeftHTMLChecker.java
+++ b/src/main/java/org/apache/maven/dist/tools/site/checkers/StylusLeftHTMLChecker.java
@@ -25,24 +25,33 @@ import org.jsoup.nodes.Element;
/**
* Check if artifact version is present on left side in stylus skin.
- *
+ *
* @author skygo
*/
public class StylusLeftHTMLChecker implements HTMLChecker
{
+ /**
+ * Stylus Left Html Checker
+ */
+ public StylusLeftHTMLChecker()
+ {
+ }
+ /** {@inheritDoc} */
@Override
public String getName()
{
return "Stylus left side";
}
+ /** {@inheritDoc} */
@Override
public String getSkin()
{
return "Stylus";
}
+ /** {@inheritDoc} */
@Override
public boolean isDisplayedArtifactVersionOk( Document doc, String version )
{
diff --git a/src/main/java/org/apache/maven/dist/tools/site/checkers/StylusRightHTMLChecker.java b/src/main/java/org/apache/maven/dist/tools/site/checkers/StylusRightHTMLChecker.java
index b3a790e..a474f0d 100644
--- a/src/main/java/org/apache/maven/dist/tools/site/checkers/StylusRightHTMLChecker.java
+++ b/src/main/java/org/apache/maven/dist/tools/site/checkers/StylusRightHTMLChecker.java
@@ -25,24 +25,33 @@ import org.jsoup.nodes.Element;
/**
* Check if artifact version is present on right side in stylus skin.
- *
+ *
* @author skygo
*/
public class StylusRightHTMLChecker implements HTMLChecker
{
+ /**
+ * Stylus Right Html Checker
+ */
+ public StylusRightHTMLChecker()
+ {
+ }
+ /** {@inheritDoc} */
@Override
public String getName()
{
return "Stylus right side";
}
+ /** {@inheritDoc} */
@Override
public String getSkin()
{
return "Stylus";
}
+ /** {@inheritDoc} */
@Override
public boolean isDisplayedArtifactVersionOk( Document doc, String version )
{
diff --git a/src/main/java/org/apache/maven/dist/tools/source/DistCheckSourceReleaseReport.java b/src/main/java/org/apache/maven/dist/tools/source/DistCheckSourceReleaseReport.java
index 7df81e8..53279db 100644
--- a/src/main/java/org/apache/maven/dist/tools/source/DistCheckSourceReleaseReport.java
+++ b/src/main/java/org/apache/maven/dist/tools/source/DistCheckSourceReleaseReport.java
@@ -53,8 +53,17 @@ public class DistCheckSourceReleaseReport
{
private static final String NOT_IN_DISTRIBUTION_AREA = "_not_in_distribution_area_";
+ /** Constant <code>FAILURES_FILENAME="check-source-release.log"</code> */
public static final String FAILURES_FILENAME = "check-source-release.log";
+ /**
+ * Dist Check Source Release Report
+ */
+ public DistCheckSourceReleaseReport()
+ {
+ }
+
+ /** {@inheritDoc} */
@Override
protected boolean isIndexPageCheck()
{
@@ -67,17 +76,24 @@ public class DistCheckSourceReleaseReport
@Parameter
protected List<String> ignoreDistFailures;
+ /**
+ * <p>getFailuresFilename.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
protected String getFailuresFilename()
{
return FAILURES_FILENAME;
}
+ /** {@inheritDoc} */
@Override
public String getName( Locale locale )
{
return "Dist Tool> Check Source Release";
}
+ /** {@inheritDoc} */
@Override
public String getDescription( Locale locale )
{
@@ -250,6 +266,7 @@ public class DistCheckSourceReleaseReport
sink.tableRow_();
}
+ /** {@inheritDoc} */
@Override
protected void executeReport( Locale locale )
throws MavenReportException
@@ -538,6 +555,7 @@ public class DistCheckSourceReleaseReport
return missingFiles;
}
+ /** {@inheritDoc} */
@Override
protected void checkArtifact( ConfigurationLineInfo configLine, String version )
throws MojoExecutionException
diff --git a/src/test/java/org/apache/maven/dist/tools/site/SiteReportTest.java b/src/test/java/org/apache/maven/dist/tools/site/SiteReportTest.java
index 6436dfe..e08ad6b 100644
--- a/src/test/java/org/apache/maven/dist/tools/site/SiteReportTest.java
+++ b/src/test/java/org/apache/maven/dist/tools/site/SiteReportTest.java
@@ -26,10 +26,17 @@ import org.jsoup.nodes.Document;
import org.junit.Test;
/**
- *
+ * SiteReportTest
*/
public class SiteReportTest
{
+ /**
+ * SiteReportTest
+ */
+ public SiteReportTest()
+ {
+ }
+
private String readDocument( String resource )
throws IOException
{
@@ -40,14 +47,24 @@ public class SiteReportTest
}
}
+ /**
+ * Test Fluido skin
+ *
+ * @throws IOException if the resource cannot be read
+ */
@Test
public void testFluidoSkin()
throws IOException
{
String comment = readDocument( "fluido.html" );
assertTrue( comment.contains( "Fluido" ) );
- }
+ }
+ /**
+ * test Stylus Right skin
+ * *
+ * @throws IOException if the resource cannot be read
+ */
@Test
public void testStylusRightSkin()
throws IOException
diff --git a/src/test/java/org/apache/maven/dist/tools/source/PatternTest.java b/src/test/java/org/apache/maven/dist/tools/source/PatternTest.java
index fe9969e..96420ce 100644
--- a/src/test/java/org/apache/maven/dist/tools/source/PatternTest.java
+++ b/src/test/java/org/apache/maven/dist/tools/source/PatternTest.java
@@ -23,12 +23,19 @@ import org.apache.maven.dist.tools.source.DistCheckSourceReleaseReport;
import org.junit.Test;
/**
+ * PatternTest
*
* @author skygo
*/
public class PatternTest
{
-
+ /**
+ * Test Pattern
+ */
+ public PatternTest()
+ {
+ }
+
/**
* Test of getGroupId method, of class ConfigurationLineInfo.
*/