org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters

Class AliasesShouldBeListedInDictionaryRuleParametersFactory

java.lang.Object

org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.AbstractRuleParametersFactory<AliasesShouldBeListedInDictionary>

org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.AliasesShouldBeListedInDictionaryRuleParametersFactory

public class AliasesShouldBeListedInDictionaryRuleParametersFactory
extends AbstractRuleParametersFactory<AliasesShouldBeListedInDictionary>

An implementation of AbstractRuleParametersFactory for the AliasesShouldBeListedInDictionaryRule.

Author:

thewonderlemming

Constructor Summary

Constructors

Constructor and Description
AliasesShouldBeListedInDictionaryRuleParametersFactory(BuiltInRules mojoParameters) Default constructor.

Method Summary

Modifier and Type	Method and Description
protected boolean	getActivatedParameter(AliasesShouldBeListedInDictionary pojoParameters) Extracts and returns the value of the isActivated parameter from a POJO in the BuiltInRules POJO.
protected AliasesShouldBeListedInDictionary	getPojoFromBuiltInRules(BuiltInRules mojoParameters) Retrieves the rule configuration POJO from the BuiltInRules POJO.
protected Set<String>	getRuleParametersKeys() Returns the parameters names for the current AbstractLintingRule.
protected Optional<String>	getValueForParameter(String key, AliasesShouldBeListedInDictionary pojoParameters) Extracts and returns the value of the given parameter key from a POJO in the BuiltInRules POJO.

Methods inherited from class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.AbstractRuleParametersFactory

getRuleParameters, isActivated

Methods inherited from class java.lang.Object

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

Constructor Detail

AliasesShouldBeListedInDictionaryRuleParametersFactory

public AliasesShouldBeListedInDictionaryRuleParametersFactory(BuiltInRules mojoParameters)

Default constructor.

Parameters:

mojoParameters - the POJO that contains the pom.xml configuration.

Method Detail

getActivatedParameter

protected boolean getActivatedParameter(AliasesShouldBeListedInDictionary pojoParameters)

Extracts and returns the value of the isActivated parameter from a POJO in the BuiltInRules POJO.

Specified by:

getActivatedParameter in class AbstractRuleParametersFactory<AliasesShouldBeListedInDictionary>

Parameters:

pojoParameters - the POJO that holds the pom.xml plugin configuration.

Returns:

the value of the isActivated parameter.

getPojoFromBuiltInRules

protected AliasesShouldBeListedInDictionary getPojoFromBuiltInRules(BuiltInRules mojoParameters)

Retrieves the rule configuration POJO from the BuiltInRules POJO.

Specified by:

getPojoFromBuiltInRules in class AbstractRuleParametersFactory<AliasesShouldBeListedInDictionary>

Parameters:

mojoParameters - the POJO that hosts the rule configuration object.

Returns:

the rule configuration object.

getRuleParametersKeys

protected Set<String> getRuleParametersKeys()

Returns the parameters names for the current AbstractLintingRule.

Specified by:

getRuleParametersKeys in class AbstractRuleParametersFactory<AliasesShouldBeListedInDictionary>

Returns:

the parameters names for the rule.

getValueForParameter

protected Optional<String> getValueForParameter(String key,
                                                AliasesShouldBeListedInDictionary pojoParameters)

Extracts and returns the value of the given parameter key from a POJO in the BuiltInRules POJO.

Specified by:

getValueForParameter in class AbstractRuleParametersFactory<AliasesShouldBeListedInDictionary>

Parameters:

key - the name of the parameter to retrieves the value from.

pojoParameters - the POJO that holds the pom.xml plugin configuration.

Returns:

the value of the key parameter.