org.thewonderlemming.c4plantuml.linter.rules.builtin

Class AliasesShouldBeUniqueRule

java.lang.Object

org.thewonderlemming.c4plantuml.linter.rules.AbstractLintingRule

org.thewonderlemming.c4plantuml.linter.rules.builtin.AbstractC4Rule

org.thewonderlemming.c4plantuml.linter.rules.builtin.AliasesShouldBeUniqueRule

public class AliasesShouldBeUniqueRule
extends AbstractC4Rule

A linting rule that checks that aliases are not declared more than once. They can of course be used several times in many relationships but only once as entities.

Author:

thewonderlemming

Constructor Summary

Constructors

Constructor and Description
AliasesShouldBeUniqueRule(RuleParameters parameters) Default constructor.

Method Summary

Modifier and Type	Method and Description
Optional<? extends org.antlr.v4.runtime.tree.ParseTreeListener>	createParseTreeListener(org.thewonderlemming.c4plantuml.commons.Reporter reporter, Class<? extends org.antlr.v4.runtime.Parser> parserType) Returns a ParseTreeListener given a Parser type.

Methods inherited from class org.thewonderlemming.c4plantuml.linter.rules.builtin.AbstractC4Rule

acceptableParsersTypes, selectParseTree, wrapUp

Methods inherited from class org.thewonderlemming.c4plantuml.linter.rules.AbstractLintingRule

clearSyntaxErrors, getLogger, getParameters, getSyntaxErrors, reportSyntaxError

Methods inherited from class java.lang.Object

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

Constructor Detail

AliasesShouldBeUniqueRule

public AliasesShouldBeUniqueRule(RuleParameters parameters)

Default constructor.

The RuleParameters object that is passed to the class is empty for now as there is no need for any custom parameter.

Parameters:

parameters - the RuleParameters object that is being passed to the rule.

Method Detail

createParseTreeListener

public Optional<? extends org.antlr.v4.runtime.tree.ParseTreeListener> createParseTreeListener(org.thewonderlemming.c4plantuml.commons.Reporter reporter,
                                                                                               Class<? extends org.antlr.v4.runtime.Parser> parserType)

Returns a ParseTreeListener given a Parser type.

The Reporter can be passed at the ParseTreeListener if needed.

Creates a AliasesShouldBeUniqueListener instance as a listener.

Specified by:

createParseTreeListener in class AbstractLintingRule

Parameters:

reporter - the Reporter to pass to the new ParseTreeListener.

parserType - the Parser for the current C4 grammar.

Returns:

the ParseTreeListener that matches the Parser grammar.