Skip to content

Commit 8c92bda

Browse files
committed
Clarify availability of AbstractEnforcerRule
Improve links to javadoc Fix some typos
1 parent b3208e1 commit 8c92bda

File tree

7 files changed

+8
-8
lines changed

7 files changed

+8
-8
lines changed

enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/AbstractEnforcerRule.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
* <a href="https://maven.apache.org/enforcer/enforcer-api/writing-a-custom-rule.html">Writing a custom rule</a>
2626
*
2727
* @author Slawomir Jaranowski
28-
* @since 3.2.0
28+
* @since 3.2.1
2929
*/
3030
public abstract class AbstractEnforcerRule extends AbstractEnforcerRuleBase {
3131

enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/AbstractEnforcerRuleBase.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* Used for internal purpose.
2525
*
2626
* @author Slawomir Jaranowski
27-
* @since 3.2.0
27+
* @since 3.2.1
2828
*/
2929
abstract class AbstractEnforcerRuleBase implements EnforcerRuleBase {
3030

enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/AbstractEnforcerRuleConfigProvider.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
* Provided configuration will be added to current rules list by {@code Enforcer Mojo}
2727
*
2828
* @author Slawomir Jaranowski
29-
* @since 3.2.0
29+
* @since 3.2.1
3030
*/
3131
public abstract class AbstractEnforcerRuleConfigProvider extends AbstractEnforcerRuleBase {
3232

enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerLogger.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* Logger used by enforcer rule.
2525
*
2626
* @author Slawomir Jaranowski
27-
* @since 3.2.0
27+
* @since 3.2.1
2828
*/
2929
public interface EnforcerLogger {
3030

enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleBase.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* Used for internal purpose.
2525
*
2626
* @author Slawomir Jaranowski
27-
* @since 3.2.0
27+
* @since 3.2.1
2828
*/
2929
public interface EnforcerRuleBase {
3030

enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleError.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
* This exception break a build immediate.
2626
*
2727
* @author Slawomir Jaranowski
28-
* @since 3.2.0
28+
* @since 3.2.1
2929
*/
3030
public class EnforcerRuleError extends EnforcerRuleException {
3131

enforcer-api/src/site/apt/writing-a-custom-rule.apt.vm

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Writing a custom rule
4949

5050
* Implementation of custom Enforcer Rule
5151

52-
The rule must extends the {{{./apidocs/index.html}AbstractEnforcerRule}} and implements <<<execute>>> method.
52+
The rule must extend {{{./apidocs/org/apache/maven/enforcer/rule/api/AbstractEnforcerRule.html}AbstractEnforcerRule}} (available since API version 3.2.1) and implement its <<<execute>>> method.
5353

5454
Add annotation <<<@Named("yourRuleName")>>> to your Rule class. Your Rule name must start with lowercase character.
5555

@@ -58,7 +58,7 @@ Writing a custom rule
5858
Maven component can be injected into Rule by annotation <<<@Inject>>> on field or constructor.
5959

6060
Entry point for Rule executing is <<<execute>>> method, tf the rule succeeds, it should just simply return.
61-
If the rule fails, it should throw an {{{./apidocs/index.html}EnforcerRuleException}} with a descriptive message telling the user why the rule failed.
61+
If the rule fails, it should throw an {{{./apidocs/org/apache/maven/enforcer/rule/api/EnforcerRuleException.html}EnforcerRuleException}} with a descriptive message telling the user why the rule failed.
6262
Enforcer plugin takes decision based on configuration and Enforcer Rule level whether build should pass or fail.
6363
In case when you want to brake build immediately, <<<execute>>> method can throw an {{{./apidocs/index.html}EnforcerRuleError}}.
6464

0 commit comments

Comments
 (0)