This is an automated email from the ASF dual-hosted git repository. elharo pushed a commit to branch df in repository https://gitbox.apache.org/repos/asf/maven-enforcer.git
commit 3d55e3e460d8bba944dcad2a64e0cbbdb0532ceb Author: Elliotte Rusty Harold <[email protected]> AuthorDate: Tue Jan 13 07:29:56 2026 -0500 Follow Oracle Javadoc conventions --- .../enforcer/rule/api/AbstractEnforcerRule.java | 8 ++--- .../rule/api/AbstractEnforcerRuleBase.java | 4 +-- .../maven/enforcer/rule/api/EnforcerLogger.java | 8 ++--- .../maven/enforcer/rule/api/EnforcerRule.java | 2 +- .../maven/enforcer/rule/api/EnforcerRuleBase.java | 6 ++-- .../enforcer/rule/api/EnforcerRuleException.java | 2 +- .../rules/AbstractStandardEnforcerRule.java | 7 ++-- .../apache/maven/enforcer/rules/AlwaysFail.java | 1 + .../apache/maven/enforcer/rules/AlwaysPass.java | 1 + .../maven/enforcer/rules/BannedRepositories.java | 8 ++--- .../maven/enforcer/rules/EvaluateBeanshell.java | 5 +-- .../enforcer/rules/ReactorModuleConvergence.java | 42 +++++++++++----------- .../maven/enforcer/rules/RequireActiveProfile.java | 6 ++-- .../maven/enforcer/rules/RequireJavaVendor.java | 2 -- .../enforcer/rules/RequireMatchingCoordinates.java | 1 + .../enforcer/rules/RequireNoRepositories.java | 2 +- .../org/apache/maven/enforcer/rules/RequireOS.java | 12 +++---- .../enforcer/rules/RequirePluginVersions.java | 12 +++---- .../maven/enforcer/rules/RequirePrerequisite.java | 2 +- .../checksum/NormalizeLineSeparatorReader.java | 3 +- .../rules/dependency/BanDynamicVersions.java | 12 +++---- .../rules/dependency/BannedDependenciesBase.java | 6 ++-- .../rules/dependency/RequireUpperBoundDeps.java | 1 + .../enforcer/rules/dependency/ResolverUtil.java | 2 +- .../enforcer/rules/files/AbstractRequireFiles.java | 2 +- .../enforcer/rules/files/RequireFilesSize.java | 6 ++-- .../property/AbstractPropertyEnforcerRule.java | 9 ++--- .../maven/enforcer/rules/utils/ArtifactUtils.java | 9 +++-- .../enforcer/rules/utils/ParentNodeProvider.java | 5 +-- .../maven/enforcer/rules/utils/ParentsVisitor.java | 2 +- .../maven/enforcer/rules/utils/PluginWrapper.java | 5 ++- .../enforcer/rules/version/RequireJavaVersion.java | 2 +- .../maven/plugins/enforcer/DisplayInfoMojo.java | 4 +-- .../apache/maven/plugins/enforcer/EnforceMojo.java | 14 ++++---- .../enforcer/internal/AbstractEnforcerLogger.java | 2 +- .../enforcer/internal/EnforcerLoggerError.java | 2 +- .../enforcer/internal/EnforcerLoggerWarn.java | 2 +- .../enforcer/internal/EnforcerRuleDesc.java | 2 +- .../enforcer/internal/EnforcerRuleManager.java | 2 +- 39 files changed, 115 insertions(+), 108 deletions(-) diff --git a/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/AbstractEnforcerRule.java b/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/AbstractEnforcerRule.java index f85cc508..2ec03c9a 100644 --- a/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/AbstractEnforcerRule.java +++ b/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/AbstractEnforcerRule.java @@ -30,7 +30,7 @@ package org.apache.maven.enforcer.rule.api; public abstract class AbstractEnforcerRule extends AbstractEnforcerRuleBase { /** - * Enforcer Rule execution level + * Enforcer Rule execution level. */ private EnforcerLevel level = EnforcerLevel.ERROR; @@ -40,7 +40,7 @@ public abstract class AbstractEnforcerRule extends AbstractEnforcerRuleBase { private String ruleName; /** - * Current Enforcer execution level + * Current Enforcer execution level. * * @return an Enforcer execution level */ @@ -52,7 +52,7 @@ public abstract class AbstractEnforcerRule extends AbstractEnforcerRuleBase { /** * Rule name for current rule instance. * - * @return a rule name. + * @return a rule name * @since 3.6.0 */ @Override @@ -79,8 +79,8 @@ public abstract class AbstractEnforcerRule extends AbstractEnforcerRuleBase { * then decide based on the fail flag and rule level if it should stop or just log the * message as a warning. * - * @throws EnforcerRuleException the enforcer rule exception * @throws EnforcerRuleError in order to brake a build immediately + * @throws EnforcerRuleException the enforcer rule exception */ public abstract void execute() throws EnforcerRuleException; } diff --git a/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/AbstractEnforcerRuleBase.java b/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/AbstractEnforcerRuleBase.java index ae2d54f1..12375af5 100644 --- a/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/AbstractEnforcerRuleBase.java +++ b/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/AbstractEnforcerRuleBase.java @@ -29,12 +29,12 @@ package org.apache.maven.enforcer.rule.api; abstract class AbstractEnforcerRuleBase implements EnforcerRuleBase { /** - * EnforcerLogger instance + * EnforcerLogger instance. */ private EnforcerLogger log; /** - * Used by {@code EnforcerMojo} to inject logger instance + * Used by {@code EnforcerMojo} to inject logger instance. * * @param log an {@link EnforcerLogger} instance */ diff --git a/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerLogger.java b/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerLogger.java index b847e441..084d4220 100644 --- a/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerLogger.java +++ b/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerLogger.java @@ -47,7 +47,7 @@ public interface EnforcerLogger { /** * Is the logger instance enabled for the DEBUG level? * - * @return {@code true} if this Logger is enabled for the DEBUG level, {@code false} otherwise. + * @return {@code true} if this Logger is enabled for the DEBUG level, {@code false} otherwise * @since 3.4.0 */ boolean isDebugEnabled(); @@ -71,7 +71,7 @@ public interface EnforcerLogger { /** * Is the logger instance enabled for the INFO level? * - * @return {@code true} if this Logger is enabled for the INFO level, {@code false} otherwise. + * @return {@code true} if this Logger is enabled for the INFO level, {@code false} otherwise * @since 3.4.0 */ boolean isInfoEnabled(); @@ -95,7 +95,7 @@ public interface EnforcerLogger { /** * Is the logger instance enabled for the WARN level? * - * @return {@code true} if this Logger is enabled for the WARN level, {@code false} otherwise. + * @return {@code true} if this Logger is enabled for the WARN level, {@code false} otherwise * @since 3.4.0 */ boolean isWarnEnabled(); @@ -119,7 +119,7 @@ public interface EnforcerLogger { /** * Is the logger instance enabled for the ERROR level? * - * @return {@code true} if this Logger is enabled for the ERROR level, {@code false} otherwise. + * @return {@code true} if this Logger is enabled for the ERROR level, {@code false} otherwise * @since 3.4.0 */ boolean isErrorEnabled(); diff --git a/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRule.java b/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRule.java index dba86da4..77fa4e16 100644 --- a/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRule.java +++ b/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRule.java @@ -37,7 +37,7 @@ public interface EnforcerRule extends EnforcerRuleBase { * then decide based on the fail flag if it should stop or just log the * message as a warning. * - * @param helper The helper provides access to the log, MavenSession and has + * @param helper the helper provides access to the log, MavenSession and has * helpers to get common components. It is also able to look up components * by class name. * @throws EnforcerRuleException the enforcer rule exception diff --git a/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleBase.java b/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleBase.java index 281fc10c..b5896227 100644 --- a/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleBase.java +++ b/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleBase.java @@ -29,7 +29,7 @@ package org.apache.maven.enforcer.rule.api; public interface EnforcerRuleBase { /** - * Current Enforcer execution level + * Current Enforcer execution level. * * @return an Enforcer execution level */ @@ -38,7 +38,7 @@ public interface EnforcerRuleBase { } /** - * Used by {@code EnforcerMojo} to inject logger instance + * Used by {@code EnforcerMojo} to inject logger instance. * * @param log an {@link EnforcerLogger} instance */ @@ -47,7 +47,7 @@ public interface EnforcerRuleBase { /** * Rule name for current rule instance. * - * @return a rule name. + * @return a rule name * @since 3.6.0 */ default String getRuleName() { diff --git a/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleException.java b/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleException.java index 041e6d05..6fac37f0 100644 --- a/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleException.java +++ b/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleException.java @@ -28,7 +28,7 @@ package org.apache.maven.enforcer.rule.api; */ public class EnforcerRuleException extends Exception { - /** serialVersionUID. */ + /** SerialVersionUID. */ private static final long serialVersionUID = 1L; /** The source. */ diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/AbstractStandardEnforcerRule.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/AbstractStandardEnforcerRule.java index 4fa58870..1704c663 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/AbstractStandardEnforcerRule.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/AbstractStandardEnforcerRule.java @@ -42,6 +42,7 @@ public abstract class AbstractStandardEnforcerRule extends AbstractEnforcerRule /** * Returns an identifier of a given project. + * * @param project the project * @return the identifier of the project in the format {@code <groupId>:<artifactId>:<version>} */ @@ -70,9 +71,9 @@ public abstract class AbstractStandardEnforcerRule extends AbstractEnforcerRule * Creates a string with line/column information for problems originating directly from this POM. Inspired by * {@code o.a.m.model.building.ModelProblemUtils.formatLocation(...)}. * - * @param project the current project. - * @param location The location which should be formatted, must not be {@code null}. - * @return The formatted problem location or an empty string if unknown, never {@code null}. + * @param project the current project + * @param location the location which should be formatted, must not be {@code null} + * @return the formatted problem location or an empty string if unknown, never {@code null} */ protected static String formatLocation(MavenProject project, InputLocation location) { StringBuilder buffer = new StringBuilder(); diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/AlwaysFail.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/AlwaysFail.java index 16a3c569..a50451db 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/AlwaysFail.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/AlwaysFail.java @@ -25,6 +25,7 @@ import org.apache.maven.enforcer.rule.api.EnforcerRuleException; /** * Always fail. This rule is useful for testing the Enforcer configuration, or to always fail the build if a particular * profile is enabled. + * * @author Ben Lidgey */ @Named("alwaysFail") diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/AlwaysPass.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/AlwaysPass.java index f3269cc7..61bd141b 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/AlwaysPass.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/AlwaysPass.java @@ -22,6 +22,7 @@ import javax.inject.Named; /** * Always pass. This rule is useful for testing the Enforcer configuration. + * * @author Ben Lidgey */ @Named("alwaysPass") diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/BannedRepositories.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/BannedRepositories.java index 368a7f84..8329bd2f 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/BannedRepositories.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/BannedRepositories.java @@ -118,10 +118,10 @@ public final class BannedRepositories extends AbstractStandardEnforcerRule { /** * Check whether specified repositories have banned repositories. * - * @param repositories: candidate repositories. - * @param includes : 'include' patterns. - * @param excludes : 'exclude' patterns. - * @return Banned repositories. + * @param repositories: candidate repositories + * @param includes : 'include' patterns + * @param excludes : 'exclude' patterns + * @return banned repositories */ private List<ArtifactRepository> checkRepositories( List<ArtifactRepository> repositories, List<String> includes, List<String> excludes) { diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/EvaluateBeanshell.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/EvaluateBeanshell.java index 8bf59367..39e330b3 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/EvaluateBeanshell.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/EvaluateBeanshell.java @@ -40,8 +40,9 @@ public final class EvaluateBeanshell extends AbstractStandardEnforcerRule { /** Beanshell interpreter. */ private final Interpreter interpreter = new Interpreter(); - /** The condition to be evaluated. - * */ + /** + * The condition to be evaluated. + */ private String condition; private final ExpressionEvaluator evaluator; diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/ReactorModuleConvergence.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/ReactorModuleConvergence.java index ff296086..2d3f6310 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/ReactorModuleConvergence.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/ReactorModuleConvergence.java @@ -86,8 +86,8 @@ public final class ReactorModuleConvergence extends AbstractStandardEnforcerRule /** * Convenience method to create a user readable message. * - * @param sortedProjects The list of reactor projects. - * @throws EnforcerRuleException In case of a violation. + * @param sortedProjects the list of reactor projects + * @throws EnforcerRuleException in case of a violation */ private void checkMissingParentsInReactor(List<MavenProject> sortedProjects) throws EnforcerRuleException { List<MavenProject> modulesWithoutParentsInReactor = existModulesWithoutParentsInReactor(sortedProjects); @@ -135,8 +135,8 @@ public final class ReactorModuleConvergence extends AbstractStandardEnforcerRule /** * Convenience method to create a user readable message. * - * @param sortedProjects The list of reactor projects. - * @throws EnforcerRuleException In case of a violation. + * @param sortedProjects the list of reactor projects + * @throws EnforcerRuleException in case of a violation */ private void checkParentsInReactor(List<MavenProject> sortedProjects) throws EnforcerRuleException { // After we are sure having consistent version we can simply use the first one? @@ -160,8 +160,8 @@ public final class ReactorModuleConvergence extends AbstractStandardEnforcerRule /** * Convenience method to create user readable message. * - * @param sortedProjects The list of reactor projects. - * @throws EnforcerRuleException In case of a violation. + * @param sortedProjects the list of reactor projects + * @throws EnforcerRuleException in case of a violation */ private void checkReactor(List<MavenProject> sortedProjects) throws EnforcerRuleException { List<MavenProject> consistenceCheckResult = isReactorVersionConsistent(sortedProjects); @@ -221,9 +221,9 @@ public final class ReactorModuleConvergence extends AbstractStandardEnforcerRule * This will check of the groupId/artifactId can be found in any reactor project. The version will be ignored cause * versions are checked before. * - * @param project The project which should be checked if it is contained in the sortedProjects. - * @param sortedProjects The list of existing projects. - * @return true if the project has been found within the list false otherwise. + * @param project the project which should be checked if it is contained in the sortedProjects + * @param sortedProjects the list of existing projects + * @return true if the project has been found within the list false otherwise */ private boolean isProjectPartOfTheReactor(MavenProject project, List<MavenProject> sortedProjects) { return isGAPartOfTheReactor(project.getGroupId(), project.getArtifactId(), sortedProjects); @@ -236,10 +236,10 @@ public final class ReactorModuleConvergence extends AbstractStandardEnforcerRule /** * This will check if the given <code>groupId/artifactId</code> is part of the current reactor. * - * @param groupId The groupId - * @param artifactId The artifactId - * @param sortedProjects The list of projects within the reactor. - * @return true if the groupId/artifactId is part of the reactor false otherwise. + * @param groupId the groupId + * @param artifactId the artifactId + * @param sortedProjects the list of projects within the reactor + * @return true if the groupId/artifactId is part of the reactor false otherwise */ private boolean isGAPartOfTheReactor(String groupId, String artifactId, List<MavenProject> sortedProjects) { boolean result = false; @@ -257,8 +257,8 @@ public final class ReactorModuleConvergence extends AbstractStandardEnforcerRule * Assume we have a module which is a child of a multi-module build but this child does not have a parent. This * method will exactly search for such cases. * - * @param sortedProjects The sorted list of the reactor modules. - * @return The resulting list will contain the modules in the reactor which do not have a parent. The list will + * @param sortedProjects the sorted list of the reactor modules + * @return the resulting list will contain the modules in the reactor which do not have a parent. The list will * never null. If the list is empty no violation have happened. */ private List<MavenProject> existModulesWithoutParentsInReactor(List<MavenProject> sortedProjects) { @@ -283,9 +283,9 @@ public final class ReactorModuleConvergence extends AbstractStandardEnforcerRule /** * Convenience method to handle adding a dependency to the Map of List. * - * @param result The result List which should be handled. - * @param project The MavenProject which will be added. - * @param dependency The dependency which will be added. + * @param result the result List which should be handled + * @param project the MavenProject which will be added + * @param dependency the dependency which will be added */ private void addDep(Map<MavenProject, List<Dependency>> result, MavenProject project, Dependency dependency) { if (result.containsKey(project)) { @@ -348,8 +348,8 @@ public final class ReactorModuleConvergence extends AbstractStandardEnforcerRule * <version>1.1-SNAPSHOT</version> * </pre> * - * @param projectList The sorted list of the reactor modules. - * @return The resulting list will contain the modules in the reactor which do the thing in the example above. The + * @param projectList the sorted list of the reactor modules + * @return the resulting list will contain the modules in the reactor which do the thing in the example above. The * list will never null. If the list is empty no violation have happened. */ private List<MavenProject> isReactorVersionConsistent(List<MavenProject> projectList) { @@ -383,7 +383,7 @@ public final class ReactorModuleConvergence extends AbstractStandardEnforcerRule /** * This will add the given user message to the output. * - * @param sb The already initialized exception message part. + * @param sb the already initialized exception message part */ private void addMessageIfExist(StringBuilder sb) { if (!StringUtils.isEmpty(getMessage())) { diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireActiveProfile.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireActiveProfile.java index 7df8486a..cd0c673d 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireActiveProfile.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireActiveProfile.java @@ -37,11 +37,13 @@ import org.apache.maven.project.MavenProject; @Named("requireActiveProfile") public final class RequireActiveProfile extends AbstractStandardEnforcerRule { - /** Comma separated list of profiles to check. + /** + * Comma separated list of profiles to check. */ private String profiles = null; - /** If all profiles must be active. If false, only one must be active + /** + * If all profiles must be active. If false, only one must be active. */ private boolean all = true; diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireJavaVendor.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireJavaVendor.java index e5ebf061..21f71720 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireJavaVendor.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireJavaVendor.java @@ -36,7 +36,6 @@ import org.apache.maven.enforcer.rule.api.EnforcerRuleException; public final class RequireJavaVendor extends AbstractStandardEnforcerRule { /** * Java vendors to include. If none is defined, all are included. - * */ private List<String> includes; @@ -115,7 +114,6 @@ public final class RequireJavaVendor extends AbstractStandardEnforcerRule { * </ul> * * @param includes the list of required vendors - * * @see #setExcludes(List) */ public void setIncludes(List<String> includes) { diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireMatchingCoordinates.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireMatchingCoordinates.java index f5aff822..f6738d8b 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireMatchingCoordinates.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireMatchingCoordinates.java @@ -29,6 +29,7 @@ import org.apache.maven.project.MavenProject; /** * This rule checks that the Maven coordinates (i.e. the project's {@code groupId} and {@code artifactId}) each match a given pattern. + * * @since 3.5.0 */ @Named("requireMatchingCoordinates") diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireNoRepositories.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireNoRepositories.java index df08c725..b7465f61 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireNoRepositories.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireNoRepositories.java @@ -226,7 +226,7 @@ public final class RequireNoRepositories extends AbstractStandardEnforcerRule { * @param repos all repositories, never {@code null} * @param allowedRepos allowed repositories, never {@code null} * @param allowSnapshots - * @return List of banned repositoreis. + * @return list of banned repositoreis */ private static List<String> findBannedRepositories( List<Repository> repos, List<String> allowedRepos, boolean allowSnapshots) { diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireOS.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireOS.java index 945cde59..36cf054e 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireOS.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireOS.java @@ -157,7 +157,7 @@ public final class RequireOS extends AbstractStandardEnforcerRule { * Helper method to determine if the current OS is allowed based on the injected values for family, name, version * and arch. * - * @return true if the version is allowed. + * @return true if the version is allowed */ public boolean isAllowed() { // empty lambda as problems collector @@ -167,7 +167,7 @@ public final class RequireOS extends AbstractStandardEnforcerRule { /** * Helper method to check that at least one of family, name, version or arch is set. * - * @return true if all parameters are empty. + * @return true if all parameters are empty */ public boolean allParamsEmpty() { return (family == null || family.isEmpty()) @@ -179,7 +179,7 @@ public final class RequireOS extends AbstractStandardEnforcerRule { /** * Creates a Profile object that contains the activation information. * - * @return a properly populated profile to be used for OS validation. + * @return a properly populated profile to be used for OS validation */ private Profile createProfile() { Profile profile = new Profile(); @@ -190,7 +190,7 @@ public final class RequireOS extends AbstractStandardEnforcerRule { /** * Creates an Activation object that contains the ActivationOS information. * - * @return a properly populated Activation object. + * @return a properly populated Activation object */ private Activation createActivation() { Activation activation = new Activation(); @@ -202,7 +202,7 @@ public final class RequireOS extends AbstractStandardEnforcerRule { /** * Creates an ActivationOS object containing family, name, version and arch. * - * @return a properly populated ActivationOS object. + * @return a properly populated ActivationOS object */ private ActivationOS createOsBean() { ActivationOS os = new ActivationOS(); @@ -279,7 +279,7 @@ public final class RequireOS extends AbstractStandardEnforcerRule { } /** - * @param display The value for the display. + * @param display the value for the display */ public void setDisplay(boolean display) { this.display = display; diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequirePluginVersions.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequirePluginVersions.java index 417ce78a..a505f1cc 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequirePluginVersions.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequirePluginVersions.java @@ -324,7 +324,7 @@ public final class RequirePluginVersions extends AbstractStandardEnforcerRule { * * @param uncheckedPlugins * @param plugins - * @return The plugins which have been removed. + * @return the plugins which have been removed */ Set<Plugin> removeUncheckedPlugins(Collection<String> uncheckedPlugins, Set<Plugin> plugins) throws EnforcerRuleError { @@ -342,7 +342,7 @@ public final class RequirePluginVersions extends AbstractStandardEnforcerRule { * * @param uncheckedPlugins a new collections * @param uncheckedPluginsList a list to merge - * @return List of unchecked plugins. + * @return list of unchecked plugins */ public Collection<String> combineUncheckedPlugins( Collection<String> uncheckedPlugins, String uncheckedPluginsList) { @@ -433,7 +433,7 @@ public final class RequirePluginVersions extends AbstractStandardEnforcerRule { * * @param plugin plugin to lookup * @param project project to search - * @return matching plugin, <code>null</code> if not found. + * @return matching plugin, <code>null</code> if not found */ private Plugin findCurrentPlugin(Plugin plugin, MavenProject project) throws EnforcerRuleException { Plugin found = null; @@ -474,8 +474,8 @@ public final class RequirePluginVersions extends AbstractStandardEnforcerRule { * @param project the project * @param phases the phases * @return the bound plugins - * @throws PluginNotFoundException the plugin not found exception * @throws LifecycleExecutionException the lifecycle execution exception + * @throws PluginNotFoundException the plugin not found exception */ private Set<Plugin> getBoundPlugins(MavenProject project, String phases) throws PluginNotFoundException, LifecycleExecutionException { @@ -591,8 +591,8 @@ public final class RequirePluginVersions extends AbstractStandardEnforcerRule { * @param project the project * @param lifecycle the lifecycle * @return the all plugins - * @throws PluginNotFoundException the plugin not found exception * @throws LifecycleExecutionException the lifecycle execution exception + * @throws PluginNotFoundException the plugin not found exception */ private Set<Plugin> getAllPlugins(MavenProject project, Lifecycle lifecycle) throws PluginNotFoundException, LifecycleExecutionException { @@ -799,7 +799,7 @@ public final class RequirePluginVersions extends AbstractStandardEnforcerRule { /** * Gets all plugin entries in build.plugins, build.pluginManagement.plugins, profile.build.plugins, reporting and - * profile.reporting in this project and all parents + * profile.reporting in this project and all parents. * * @param project the project * @return the all plugin entries wrapped in a PluginWrapper Object diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequirePrerequisite.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequirePrerequisite.java index 5af436c2..6e7e6c1f 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequirePrerequisite.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequirePrerequisite.java @@ -67,8 +67,8 @@ public final class RequirePrerequisite extends AbstractStandardEnforcerRule { /** * Only the projects with one of these packagings will be enforced to have the correct prerequisite. * - * @since 1.4 * @param packagings the list of packagings + * @since 1.4 */ public void setPackagings(List<String> packagings) { this.packagings = packagings; diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/checksum/NormalizeLineSeparatorReader.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/checksum/NormalizeLineSeparatorReader.java index 5ef8f438..d2b3a39d 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/checksum/NormalizeLineSeparatorReader.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/checksum/NormalizeLineSeparatorReader.java @@ -30,7 +30,7 @@ class NormalizeLineSeparatorReader extends FilterReader { private static final int EOL = -1; /** - * Type representing either Unix or Windows line separators + * Type representing either Unix or Windows line separators. */ public enum LineSeparator { WINDOWS("\r\n", null), @@ -53,6 +53,7 @@ class NormalizeLineSeparatorReader extends FilterReader { /** * Checks if two given characters match the line separator represented by this object. + * * @param currentCharacter the character to check against * @param previousCharacter optional previous character (may be {@code null}) * @return one of {@link MatchResult} diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BanDynamicVersions.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BanDynamicVersions.java index 49f3fa20..81e55cc7 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BanDynamicVersions.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BanDynamicVersions.java @@ -66,22 +66,22 @@ public final class BanDynamicVersions extends AbstractStandardEnforcerRule { private static final String SNAPSHOT_SUFFIX = "-SNAPSHOT"; /** - * {@code true} if versions ending with {@code -SNAPSHOT} should be allowed + * {@code true} if versions ending with {@code -SNAPSHOT} should be allowed. */ private boolean allowSnapshots; /** - * {@code true} if versions using {@code LATEST} should be allowed + * {@code true} if versions using {@code LATEST} should be allowed. */ private boolean allowLatest; /** - * {@code true} if versions using {@code RELEASE} should be allowed + * {@code true} if versions using {@code RELEASE} should be allowed. */ private boolean allowRelease; /** - * {@code true} if version ranges should be allowed + * {@code true} if version ranges should be allowed. */ private boolean allowRanges; @@ -92,12 +92,12 @@ public final class BanDynamicVersions extends AbstractStandardEnforcerRule { private boolean allowRangesWithIdenticalBounds; /** - * {@code true} if optional dependencies should not be checked + * {@code true} if optional dependencies should not be checked. */ private boolean excludeOptionals; /** - * the scopes of dependencies which should be excluded from this rule + * The scopes of dependencies which should be excluded from this rule. */ private List<String> excludedScopes = Collections.emptyList(); diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BannedDependenciesBase.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BannedDependenciesBase.java index f06e414c..9c5d06ae 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BannedDependenciesBase.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BannedDependenciesBase.java @@ -145,7 +145,7 @@ abstract class BannedDependenciesBase extends AbstractStandardEnforcerRule { protected abstract String getErrorMessage(); /** - * Validates a dependency artifact if it fulfills the enforcer rule + * Validates a dependency artifact if it fulfills the enforcer rule. * * @param dependency dependency to be checked against the list of excludes * @return {@code true} if the dependency <b>passes</b> the rule, {@code false} if the dependency @@ -178,8 +178,8 @@ abstract class BannedDependenciesBase extends AbstractStandardEnforcerRule { * The rule will fail if any dependency matches any exclude, unless it also matches an * include rule. * - * @see #getExcludes() * @param excludes the excludes to set + * @see #getExcludes() */ public void setExcludes(List<String> excludes) { this.excludes = excludes; @@ -204,8 +204,8 @@ abstract class BannedDependenciesBase extends AbstractStandardEnforcerRule { * For example, to ban all xerces except xerces-api → exclude "xerces", * include "xerces:xerces-api" * - * @see #setIncludes(List) * @param includes the includes to set + * @see #setIncludes(List) */ public void setIncludes(List<String> includes) { this.includes = includes; diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/RequireUpperBoundDeps.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/RequireUpperBoundDeps.java index 1eb9bc76..10bae9ca 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/RequireUpperBoundDeps.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/RequireUpperBoundDeps.java @@ -89,6 +89,7 @@ public final class RequireUpperBoundDeps extends AbstractStandardEnforcerRule { /** * Sets dependencies to exclude. + * * @param excludes a list of {@code groupId:artifactId} names */ public void setExcludes(List<String> excludes) { diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/ResolverUtil.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/ResolverUtil.java index 6ccd62b2..adba069b 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/ResolverUtil.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/ResolverUtil.java @@ -59,7 +59,7 @@ class ResolverUtil { private final MavenSession session; /** - * Default constructor + * Default constructor. */ @Inject ResolverUtil(RepositorySystem repositorySystem, MavenSession session) { diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/files/AbstractRequireFiles.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/files/AbstractRequireFiles.java index da9019f4..f425875d 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/files/AbstractRequireFiles.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/files/AbstractRequireFiles.java @@ -37,7 +37,7 @@ abstract class AbstractRequireFiles extends AbstractStandardEnforcerRule { /** List of files to check. */ private List<File> files = Collections.emptyList(); - /** if null file handles should be allowed. If they are allowed, it means treat it as a success. */ + /** If null file handles should be allowed. If they are allowed, it means treat it as a success. */ private boolean allowNulls = false; /** Allow that a single one of the files can make the rule to pass. */ diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/files/RequireFilesSize.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/files/RequireFilesSize.java index f8395080..2dbf7f0f 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/files/RequireFilesSize.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/files/RequireFilesSize.java @@ -39,13 +39,13 @@ public final class RequireFilesSize extends AbstractRequireFiles { private static final long MAXSIZE = 10000; - /** the max size allowed. */ + /** The max size allowed. */ private long maxsize = MAXSIZE; - /** the min size allowed. */ + /** The min size allowed. */ private long minsize = 0; - /** the mode for computing the size when the files are directories. */ + /** The mode for computing the size when the files are directories. */ private boolean recursive = false; /** The error msg. */ diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/property/AbstractPropertyEnforcerRule.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/property/AbstractPropertyEnforcerRule.java index 305a5e23..517ea556 100755 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/property/AbstractPropertyEnforcerRule.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/property/AbstractPropertyEnforcerRule.java @@ -48,7 +48,7 @@ abstract class AbstractPropertyEnforcerRule extends AbstractStandardEnforcerRule /** * Set the property value to a given regular expression. Defaults to <code>null</code> (any value is ok). * - * @param regex The regular expression + * @param regex the regular expression */ public final void setRegex(String regex) { this.regex = regex; @@ -104,20 +104,21 @@ abstract class AbstractPropertyEnforcerRule extends AbstractStandardEnforcerRule } /** - * How the property that is being evaluated is called + * How the property that is being evaluated is called. + * * @return kind of property */ protected abstract String getName(); /** - * The name of the property currently being evaluated, this is used for default message purposes only + * The name of the property currently being evaluated, this is used for default message purposes only. * * @return the name of the property */ protected abstract String getPropertyName(); /** - * Resolves the property value + * Resolves the property value. * * @return a resolve value * @throws EnforcerRuleException in case of problems diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/ArtifactUtils.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/ArtifactUtils.java index 2ab6723c..2392eb21 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/ArtifactUtils.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/ArtifactUtils.java @@ -34,7 +34,6 @@ import org.eclipse.aether.graph.DependencyNode; import static java.util.Optional.ofNullable; /** - * * @author Robert Scholte * @since 3.0.0 */ @@ -59,7 +58,7 @@ public final class ArtifactUtils { } /** - * Returns a subset of dependency artifacts that match the given collection of patterns + * Returns a subset of dependency artifacts that match the given collection of patterns. * * @param dependencies dependency artifacts to match against patterns * @param patterns patterns to match against the artifacts @@ -91,7 +90,7 @@ public final class ArtifactUtils { * This can improve efficiency where there are lots of patterns and/or artifacts to match. * * @param patterns the patterns to use for the predicate - * @return a re-usable predicate. + * @return a re-usable predicate */ public static Predicate<Artifact> prepareDependencyArtifactMatcher(Collection<String> patterns) { return cleansePatterns(patterns) @@ -105,7 +104,7 @@ public final class ArtifactUtils { * Cleans the patterns provided ready for use in {@link ArtifactMatcher.Pattern} * * @param patterns the patterns to be cleaned - * @return a Stream of the patterns prepared for use. + * @return a Stream of the patterns prepared for use */ private static Stream<String> cleansePatterns(Collection<String> patterns) { return ofNullable(patterns) @@ -120,7 +119,7 @@ public final class ArtifactUtils { * Compares the given pattern against the given artifact. The pattern should follow the format * <code>groupId:artifactId:version:type:scope:classifier</code>. * - * @param pattern The pattern to compare the artifact with. + * @param pattern the pattern to compare the artifact with * @param artifact the artifact * @return <code>true</code> if the artifact matches one of the patterns */ diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/ParentNodeProvider.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/ParentNodeProvider.java index e99c0513..187566e3 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/ParentNodeProvider.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/ParentNodeProvider.java @@ -21,12 +21,13 @@ package org.apache.maven.enforcer.rules.utils; import org.eclipse.aether.graph.DependencyNode; /** - * Provides the information about {@link org.eclipse.aether.graph.DependencyNode} parent nodes + * Provides the information about {@link org.eclipse.aether.graph.DependencyNode} parent nodes. */ public interface ParentNodeProvider { /** - * Returns the parent node of the given node + * Returns the parent node of the given node. + * * @param node node to get the information for * @return parent node or {@code null} is no information is known */ diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/ParentsVisitor.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/ParentsVisitor.java index 13d10aa0..6e0353a3 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/ParentsVisitor.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/ParentsVisitor.java @@ -27,7 +27,7 @@ import org.eclipse.aether.graph.DependencyNode; import org.eclipse.aether.graph.DependencyVisitor; /** - * A {@link DependencyVisitor} building a map of parent nodes + * A {@link DependencyVisitor} building a map of parent nodes. */ public class ParentsVisitor implements DependencyVisitor, ParentNodeProvider { diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/PluginWrapper.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/PluginWrapper.java index 5fd5e417..b0863c18 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/PluginWrapper.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/PluginWrapper.java @@ -30,7 +30,6 @@ import org.apache.maven.model.ReportPlugin; /** * @author Brian Fox - * */ public class PluginWrapper { private final String groupId; @@ -68,7 +67,7 @@ public class PluginWrapper { /** * Whether the version is coming from the default lifecycle bindings. - * Cannot be determined before Maven 3.6.1 + * Cannot be determined before Maven 3.6.1. * * @param o either Plugin or ReportPlugin * @return null if untraceable, otherwise its matching value @@ -87,7 +86,7 @@ public class PluginWrapper { /** * Whether the version is coming from the super POM. - * Cannot be determined before Maven 3.6.1 + * Cannot be determined before Maven 3.6.1. * * @param o either Plugin or ReportPlugin * @return null if untraceable, otherwise its matching value diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/version/RequireJavaVersion.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/version/RequireJavaVersion.java index caee647e..05020f02 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/version/RequireJavaVersion.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/version/RequireJavaVersion.java @@ -102,7 +102,7 @@ public final class RequireJavaVersion extends AbstractVersionEnforcer { } /** - * Converts a JDK string from 1.5.0-11b12 to a single 3 digit version like 1.5.0-11 + * Converts a JDK string from 1.5.0-11b12 to a single 3 digit version like 1.5.0-11. * * @param jdkVersion to be converted * @return the converted string diff --git a/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/DisplayInfoMojo.java b/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/DisplayInfoMojo.java index 9311fc21..838e9081 100644 --- a/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/DisplayInfoMojo.java +++ b/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/DisplayInfoMojo.java @@ -36,13 +36,13 @@ import org.apache.maven.plugins.annotations.Parameter; public class DisplayInfoMojo extends AbstractMojo { /** - * The MavenSession + * The MavenSession. */ @Parameter(defaultValue = "${session}", readonly = true, required = true) protected MavenSession session; /** - * Entry point to the mojo + * Entry point to the mojo. */ public void execute() { String mavenVersion = session.getSystemProperties().getProperty("maven.version"); diff --git a/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/EnforceMojo.java b/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/EnforceMojo.java index 0ef2a945..59c43851 100644 --- a/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/EnforceMojo.java +++ b/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/EnforceMojo.java @@ -74,25 +74,25 @@ public class EnforceMojo extends AbstractMojo { protected static Map<String, EnforcerRule> cache = new ConcurrentHashMap<>(); /** - * MojoExecution needed by the ExpressionEvaluator + * MojoExecution needed by the ExpressionEvaluator. */ @Parameter(defaultValue = "${mojoExecution}", readonly = true, required = true) protected MojoExecution mojoExecution; /** - * The MavenSession + * The MavenSession. */ @Parameter(defaultValue = "${session}", readonly = true, required = true) protected MavenSession session; /** - * POM + * POM. */ @Parameter(defaultValue = "${project}", readonly = true, required = true) protected MavenProject project; /** - * Flag to easily skip all checks + * Flag to easily skip all checks. */ @Parameter(property = "enforcer.skip", defaultValue = "false") protected boolean skip = false; @@ -104,13 +104,13 @@ public class EnforceMojo extends AbstractMojo { private boolean fail = true; /** - * Fail on the first rule that doesn't pass + * Fail on the first rule that doesn't pass. */ @Parameter(property = "enforcer.failFast", defaultValue = "false") private boolean failFast = false; /** - * Flag to fail the build if no rules are present + * Flag to fail the build if no rules are present. * * @since 3.2.0 */ @@ -403,7 +403,7 @@ public class EnforceMojo extends AbstractMojo { } /** - * This method determines if a rule should execute based on the cache + * This method determines if a rule should execute based on the cache. * * @param rule the rule to verify * @return {@code true} if rule should be executed, otherwise {@code false} diff --git a/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/AbstractEnforcerLogger.java b/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/AbstractEnforcerLogger.java index 6d32d028..abf765cd 100644 --- a/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/AbstractEnforcerLogger.java +++ b/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/AbstractEnforcerLogger.java @@ -25,7 +25,7 @@ import org.apache.maven.enforcer.rule.api.EnforcerLogger; import org.apache.maven.plugin.logging.Log; /** - * Base EnforcerLogger implementation + * Base EnforcerLogger implementation. * * @author Slawomir Jaranowski * @since 3.2.0 diff --git a/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/EnforcerLoggerError.java b/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/EnforcerLoggerError.java index 981f939d..a3178a8d 100644 --- a/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/EnforcerLoggerError.java +++ b/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/EnforcerLoggerError.java @@ -23,7 +23,7 @@ import java.util.function.Supplier; import org.apache.maven.plugin.logging.Log; /** - * EnforcerLogger implementation for {@code ERROR} execution level + * EnforcerLogger implementation for {@code ERROR} execution level. * * @author Slawomir Jaranowski * @since 3.2.0 diff --git a/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/EnforcerLoggerWarn.java b/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/EnforcerLoggerWarn.java index 3ec547ac..738317d3 100644 --- a/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/EnforcerLoggerWarn.java +++ b/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/EnforcerLoggerWarn.java @@ -23,7 +23,7 @@ import java.util.function.Supplier; import org.apache.maven.plugin.logging.Log; /** - * EnforcerLogger implementation for {@code WARN} execution level + * EnforcerLogger implementation for {@code WARN} execution level. * * @author Slawomir Jaranowski * @since 3.2.0 diff --git a/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/EnforcerRuleDesc.java b/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/EnforcerRuleDesc.java index 2338e219..541caa43 100644 --- a/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/EnforcerRuleDesc.java +++ b/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/EnforcerRuleDesc.java @@ -34,7 +34,7 @@ public final class EnforcerRuleDesc { private final EnforcerRuleBase rule; /** - * Create a new Rule Description + * Create a new Rule Description. * * @param name a rule name * @param rule a rule instance diff --git a/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/EnforcerRuleManager.java b/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/EnforcerRuleManager.java index fe687901..842d5a03 100644 --- a/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/EnforcerRuleManager.java +++ b/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/EnforcerRuleManager.java @@ -80,7 +80,7 @@ public class EnforcerRuleManager { * * @param rules a rules configuration * @param log a Mojo logger - * @return List of rule instances + * @return list of rule instances * @throws EnforcerRuleManagerException report a problem during rules creating */ public List<EnforcerRuleDesc> createRules(PlexusConfiguration rules, Log log) throws EnforcerRuleManagerException {
