org.thewonderlemming.c4plantuml.mojo.linting.rules.custom

## Class AbstractCustomLintingRuleFactory<R extends AbstractCustomLintingRule>

- java.lang.Object
- - org.thewonderlemming.c4plantuml.mojo.linting.rules.custom.AbstractCustomLintingRuleFactory<R>

- Type Parameters:
    `R` - the type of `AbstractCustomLintingRule` to build.

      public abstract class AbstractCustomLintingRuleFactory<R extends AbstractCustomLintingRule>
      extends Object

  A factory to create a `AbstractCustomLintingRule`.

  Extend the following class if you intend to create your own rules but don't want to integrate them to the current plugin.

  Please note that you'll also have to to implement a `AbstractCustomLintingRule`.

  Author:
    thewonderlemming

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `AbstractCustomLintingRuleFactory()`

  - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `abstract Optional<R>` | `createCustomRule(Properties parameters)` Creates an instance of `AbstractCustomLintingRule` given a set of `Properties` gathered from the `pom.xml` file..

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### AbstractCustomLintingRuleFactory

          public AbstractCustomLintingRuleFactory()

  - ### Method Detail

    - #### createCustomRule

          public abstract Optional<R> createCustomRule(Properties parameters)

      Creates an instance of `AbstractCustomLintingRule` given a set of `Properties` gathered from the `pom.xml` file..
      Parameters:
        `parameters` - the `pom.xml` configuration.
      Returns:
        an `Optional` of the newly created instance, or empty on failure.

Copyright © 2020. All rights reserved.