Skip navigation links
A B C D E F G I L M N O P R S V W 

A

AbstractCustomLintingRule - Class in org.thewonderlemming.c4plantuml.mojo.linting.rules.custom
A base class to build custom AbstractLintingRule.
AbstractCustomLintingRule(RuleParameters) - Constructor for class org.thewonderlemming.c4plantuml.mojo.linting.rules.custom.AbstractCustomLintingRule
Creates the custom rule, given its parameters.
AbstractCustomLintingRuleFactory<R extends AbstractCustomLintingRule> - Class in org.thewonderlemming.c4plantuml.mojo.linting.rules.custom
A factory to create a AbstractCustomLintingRule.
AbstractCustomLintingRuleFactory() - Constructor for class org.thewonderlemming.c4plantuml.mojo.linting.rules.custom.AbstractCustomLintingRuleFactory
 
AbstractParentMojo - Class in org.thewonderlemming.c4plantuml.mojo
A base implementation of a MOJO that handles shared parameters such as Charset, MavenProject, and so on.
AbstractParentMojo() - Constructor for class org.thewonderlemming.c4plantuml.mojo.AbstractParentMojo
 
AbstractRuleParametersFactory<P> - Class in org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin
A base implementation of a factory pattern to build RuleParameters for any AbstractLintingRule.
AbstractRuleParametersFactory(BuiltInRules) - Constructor for class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.AbstractRuleParametersFactory
Default constructor.
AliasesShouldBeListedInDictionary - Class in org.thewonderlemming.c4plantuml.mojo.linting
A simple POJO to enforce typing for the AliasesShouldBeListedInDictionaryRule parameters in the pom.xml.
AliasesShouldBeListedInDictionary() - Constructor for class org.thewonderlemming.c4plantuml.mojo.linting.AliasesShouldBeListedInDictionary
 
AliasesShouldBeListedInDictionaryRuleParametersFactory - Class in org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters
An implementation of AbstractRuleParametersFactory for the AliasesShouldBeListedInDictionaryRule.
AliasesShouldBeListedInDictionaryRuleParametersFactory(BuiltInRules) - Constructor for class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.AliasesShouldBeListedInDictionaryRuleParametersFactory
Default constructor.
AliasesShouldBeUnique - Class in org.thewonderlemming.c4plantuml.mojo.linting
A simple POJO to enforce typing for the AliasesShouldBeUniqueRule parameters in the pom.xml.
AliasesShouldBeUnique() - Constructor for class org.thewonderlemming.c4plantuml.mojo.linting.AliasesShouldBeUnique
 
AliasesShouldBeUniqueRuleParametersFactory - Class in org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters
An implementation of AbstractRuleParametersFactory for the AliasesShouldBeUniqueRule.
AliasesShouldBeUniqueRuleParametersFactory(BuiltInRules) - Constructor for class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.AliasesShouldBeUniqueRuleParametersFactory
Default constructor.
AliasesShouldFollowStandardConvention - Class in org.thewonderlemming.c4plantuml.mojo.linting
A simple POJO to enforce typing for the AliasesShouldFollowStandardConventionRule parameters in the pom.xml.
AliasesShouldFollowStandardConvention() - Constructor for class org.thewonderlemming.c4plantuml.mojo.linting.AliasesShouldFollowStandardConvention
 
AliasesShouldFollowStandardConventionRuleParametersFactory - Class in org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters
An implementation of AbstractRuleParametersFactory for the AliasesShouldFollowStandardConventionRule.
AliasesShouldFollowStandardConventionRuleParametersFactory(BuiltInRules) - Constructor for class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.AliasesShouldFollowStandardConventionRuleParametersFactory
Default constructor.

B

BuiltInLintingRulesFactory - Enum in org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin
Maps AbstractLintingRule classes to their AbstractRuleParametersFactory and their name.
BuiltInRules - Class in org.thewonderlemming.c4plantuml.mojo.linting
A POJO to enforce typing for AbstractCustomLintingRule in the pom.xml file.
BuiltInRules() - Constructor for class org.thewonderlemming.c4plantuml.mojo.linting.BuiltInRules
Default constructor.

C

containsReports() - Method in class org.thewonderlemming.c4plantuml.mojo.MojoReporter
Checks whether or not the current Reporter instance contains messages.
createCustomRule(Properties) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.custom.AbstractCustomLintingRuleFactory
Creates an instance of AbstractCustomLintingRule given a set of Properties gathered from the pom.xml file..
createInstanceForName(String, BuiltInRules) - Static method in enum org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.BuiltInLintingRulesFactory
Builds a AbstractLintingRule instance, given its name and the BuiltInRules parameters POJO.

D

DEFAULT_COPYRIGHT_NAME - Static variable in class org.thewonderlemming.c4plantuml.mojo.WatermarkingMojo
Default copyright name, if none is provided.
DEFAULT_DATE_FORMATTER - Static variable in class org.thewonderlemming.c4plantuml.mojo.WatermarkingMojo
Default format for the date, if an invalid formatting pattern or no pattern is provided.
DEFAULT_SOURCE_FILE_EXTENSION - Static variable in class org.thewonderlemming.c4plantuml.mojo.AbstractParentMojo
Default value for the C4 PlantUML files extension.
DEFAULT_WATERMARK_NAME - Static variable in class org.thewonderlemming.c4plantuml.mojo.WatermarkingMojo
Default diagram name, if none is provided.
doExecute() - Method in class org.thewonderlemming.c4plantuml.mojo.AbstractParentMojo
An abstract method to hold the children classes execution logic.
doExecute() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.LintingMojo
Parses the C4 PlantUML files to find linting violations, and breaks the build if the failOnLintErrors is set to true.
doExecute() - Method in class org.thewonderlemming.c4plantuml.mojo.ReportingMojo
Gathers information from the C4 PlantUML files and outputs it as a GraphML file.
doExecute() - Method in class org.thewonderlemming.c4plantuml.mojo.SyntaxCheckingMojo
Processes the output directory to find syntax errors in the C4 files, and breaks the file if any error was found.
doExecute() - Method in class org.thewonderlemming.c4plantuml.mojo.WatermarkingMojo
Adds watermark to the C4 PlantUML files contained in the output directory.

E

execute() - Method in class org.thewonderlemming.c4plantuml.mojo.AbstractParentMojo
The default implementation of Mojo.execute(), that sets and validates shared parameters, then calls the abstract method AbstractParentMojo.doExecute(), that needs to be implemented by children classes.

F

FAIL_ON_PARSE_ERRORS_DEFAULT_VALUE - Static variable in class org.thewonderlemming.c4plantuml.mojo.ReportingMojo
Default value for the failOnParseErrors property.
findBuiltInLintingRules() - Static method in class org.thewonderlemming.c4plantuml.mojo.linting.LintingRulesFinder
Finds and returns every non-abstract child class of AbstractLintingRule in the classpath, including within the dependencies.
findCustomLintingRuleFactories() - Static method in class org.thewonderlemming.c4plantuml.mojo.linting.LintingRulesFinder
Finds and returns every non-abstract child class of AbstractCustomLintingRule in the classpath, including within the dependencies.
FORMAT_OUTPUT_DEFAULT_VALUE - Static variable in class org.thewonderlemming.c4plantuml.mojo.ReportingMojo
Default value for the formatOutput property.

G

getActivatedParameter(P) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.AbstractRuleParametersFactory
Extracts and returns the value of the isActivated parameter from a POJO in the BuiltInRules POJO.
getActivatedParameter(AliasesShouldBeListedInDictionary) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.AliasesShouldBeListedInDictionaryRuleParametersFactory
Extracts and returns the value of the isActivated parameter from a POJO in the BuiltInRules POJO.
getActivatedParameter(AliasesShouldBeUnique) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.AliasesShouldBeUniqueRuleParametersFactory
Extracts and returns the value of the isActivated parameter from a POJO in the BuiltInRules POJO.
getActivatedParameter(AliasesShouldFollowStandardConvention) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.AliasesShouldFollowStandardConventionRuleParametersFactory
Extracts and returns the value of the isActivated parameter from a POJO in the BuiltInRules POJO.
getActivatedParameter(NoDuplicateRelationships) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.NoDuplicateRelationshipsRuleParametersFactory
Extracts and returns the value of the isActivated parameter from a POJO in the BuiltInRules POJO.
getActivatedParameter(NoOrphanAliasInBoundaries) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.NoOrphanAliasInBoundariesRuleParametersFactory
Extracts and returns the value of the isActivated parameter from a POJO in the BuiltInRules POJO.
getActivatedParameter(NoOrphanAliasInLayouts) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.NoOrphanAliasInLayoutsRuleParametersFactory
Extracts and returns the value of the isActivated parameter from a POJO in the BuiltInRules POJO.
getActivatedParameter(NoOrphanAliasInRelationships) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.NoOrphanAliasInRelationshipsRuleParametersFactory
Extracts and returns the value of the isActivated parameter from a POJO in the BuiltInRules POJO.
getAliasDefaultFormatRegex() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.AliasesShouldFollowStandardConvention
A simple getter for the aliasDefaultFormatRegex property.
getAliasDictionaryFilename() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.AliasesShouldBeListedInDictionary
A simple getter for the aliasDictionaryFilename property.
getAliasesShouldBeListedInDictionary() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.BuiltInRules
A simple getter for the aliasesShouldBeListedInDictionary property.
getAliasesShouldBeUnique() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.BuiltInRules
A simple getter for the aliasesShouldBeUnique property.
getAliasesShouldFollowStandardConvention() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.BuiltInRules
A simple getter for the aliasesShouldFollowStandardConvention property.
getCurrentCharset() - Method in class org.thewonderlemming.c4plantuml.mojo.AbstractParentMojo
Returns the current Charset value.
getNoDuplicateRelationships() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.BuiltInRules
A simple getter for the noDuplicateRelationships property.
getNoOrphanAliasInBoundaries() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.BuiltInRules
A simple getter for the noOrphanAliasInBoundaries property.
getNoOrphanAliasInLayouts() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.BuiltInRules
A simple getter for the noOrphanAliasInLayouts property.
getNoOrphanAliasInRelationships() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.BuiltInRules
A simple getter for the noOrphanAliasInRelationships property.
getOutputDirectory() - Method in class org.thewonderlemming.c4plantuml.mojo.AbstractParentMojo
Returns the project output directory path.
getPojoFromBuiltInRules(BuiltInRules) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.AbstractRuleParametersFactory
Retrieves the rule configuration POJO from the BuiltInRules POJO.
getPojoFromBuiltInRules(BuiltInRules) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.AliasesShouldBeListedInDictionaryRuleParametersFactory
Retrieves the rule configuration POJO from the BuiltInRules POJO.
getPojoFromBuiltInRules(BuiltInRules) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.AliasesShouldBeUniqueRuleParametersFactory
Retrieves the rule configuration POJO from the BuiltInRules POJO.
getPojoFromBuiltInRules(BuiltInRules) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.AliasesShouldFollowStandardConventionRuleParametersFactory
Retrieves the rule configuration POJO from the BuiltInRules POJO.
getPojoFromBuiltInRules(BuiltInRules) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.NoDuplicateRelationshipsRuleParametersFactory
Retrieves the rule configuration POJO from the BuiltInRules POJO.
getPojoFromBuiltInRules(BuiltInRules) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.NoOrphanAliasInBoundariesRuleParametersFactory
Retrieves the rule configuration POJO from the BuiltInRules POJO.
getPojoFromBuiltInRules(BuiltInRules) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.NoOrphanAliasInLayoutsRuleParametersFactory
Retrieves the rule configuration POJO from the BuiltInRules POJO.
getPojoFromBuiltInRules(BuiltInRules) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.NoOrphanAliasInRelationshipsRuleParametersFactory
Retrieves the rule configuration POJO from the BuiltInRules POJO.
getProject() - Method in class org.thewonderlemming.c4plantuml.mojo.AbstractParentMojo
Returns the current MavenProject instance.
getReports() - Method in class org.thewonderlemming.c4plantuml.mojo.MojoReporter
Retrieves the reported messages.
getRuleName() - Method in enum org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.BuiltInLintingRulesFactory
Returns the name of the current mapping.
getRuleNameForType(Class<? extends AbstractLintingRule>) - Static method in enum org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.BuiltInLintingRulesFactory
Returns the mapped name of a AbstractLintingRule, given its type.
getRuleParameters() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.AbstractRuleParametersFactory
Returns the built RuleParameters instance.
getRuleParametersKeys() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.AbstractRuleParametersFactory
Returns the parameters names for the current AbstractLintingRule.
getRuleParametersKeys() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.AliasesShouldBeListedInDictionaryRuleParametersFactory
Returns the parameters names for the current AbstractLintingRule.
getRuleParametersKeys() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.AliasesShouldBeUniqueRuleParametersFactory
Returns the parameters names for the current AbstractLintingRule.
getRuleParametersKeys() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.AliasesShouldFollowStandardConventionRuleParametersFactory
Returns the parameters names for the current AbstractLintingRule.
getRuleParametersKeys() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.NoDuplicateRelationshipsRuleParametersFactory
Returns the parameters names for the current AbstractLintingRule.
getRuleParametersKeys() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.NoOrphanAliasInBoundariesRuleParametersFactory
Returns the parameters names for the current AbstractLintingRule.
getRuleParametersKeys() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.NoOrphanAliasInLayoutsRuleParametersFactory
Returns the parameters names for the current AbstractLintingRule.
getRuleParametersKeys() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.NoOrphanAliasInRelationshipsRuleParametersFactory
Returns the parameters names for the current AbstractLintingRule.
getRuleType() - Method in enum org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.BuiltInLintingRulesFactory
Returns the AbstractLintingRule type of the current mapping.
getSourceFileExtension() - Method in class org.thewonderlemming.c4plantuml.mojo.AbstractParentMojo
Returns the current sources filename extension.
getValueForParameter(String, P) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.AbstractRuleParametersFactory
Extracts and returns the value of the given parameter key from a POJO in the BuiltInRules POJO.
getValueForParameter(String, AliasesShouldBeListedInDictionary) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.AliasesShouldBeListedInDictionaryRuleParametersFactory
Extracts and returns the value of the given parameter key from a POJO in the BuiltInRules POJO.
getValueForParameter(String, AliasesShouldBeUnique) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.AliasesShouldBeUniqueRuleParametersFactory
Extracts and returns the value of the given parameter key from a POJO in the BuiltInRules POJO.
getValueForParameter(String, AliasesShouldFollowStandardConvention) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.AliasesShouldFollowStandardConventionRuleParametersFactory
Extracts and returns the value of the given parameter key from a POJO in the BuiltInRules POJO.
getValueForParameter(String, NoDuplicateRelationships) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.NoDuplicateRelationshipsRuleParametersFactory
Extracts and returns the value of the given parameter key from a POJO in the BuiltInRules POJO.
getValueForParameter(String, NoOrphanAliasInBoundaries) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.NoOrphanAliasInBoundariesRuleParametersFactory
Extracts and returns the value of the given parameter key from a POJO in the BuiltInRules POJO.
getValueForParameter(String, NoOrphanAliasInLayouts) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.NoOrphanAliasInLayoutsRuleParametersFactory
Extracts and returns the value of the given parameter key from a POJO in the BuiltInRules POJO.
getValueForParameter(String, NoOrphanAliasInRelationships) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.NoOrphanAliasInRelationshipsRuleParametersFactory
Extracts and returns the value of the given parameter key from a POJO in the BuiltInRules POJO.

I

isActivated() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.AliasesShouldBeListedInDictionary
A simple getter for the isActivated property.
isActivated() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.AliasesShouldBeUnique
A simple getter for the isActivated property.
isActivated() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.AliasesShouldFollowStandardConvention
A simple getter for the isActivated property.
isActivated() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.NoDuplicateRelationships
A simple getter for the isActivated property.
isActivated() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.NoOrphanAliasInBoundaries
A simple getter for the isActivated property.
isActivated() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.NoOrphanAliasInLayouts
A simple getter for the isActivated property.
isActivated() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.NoOrphanAliasInRelationships
A simple getter for the isActivated property.
isActivated() - Method in class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.AbstractRuleParametersFactory
Tells whether or not the current AbstractLintingRule is enabled or disabled.
isBuiltInLintingRule(Class<? extends AbstractLintingRule>) - Static method in enum org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.BuiltInLintingRulesFactory
Tells whether or not the given AbstractLintingRule is a built-in rule, or a custom one, which requires a different building process.

L

LintingMojo - Class in org.thewonderlemming.c4plantuml.mojo.linting
A MOJO that parses the C4 PlantUML files that are contained in the output directory and applies a set of linting rules to find violations.
LintingMojo() - Constructor for class org.thewonderlemming.c4plantuml.mojo.linting.LintingMojo
 
LintingRulesFinder - Class in org.thewonderlemming.c4plantuml.mojo.linting
An utility class to detect and return AbstractLintingRule and AbstractCustomLintingRule within the classpath, including the shipped dependencies.

M

MojoReporter - Class in org.thewonderlemming.c4plantuml.mojo
A Reporter implementation that collects reported messages to enable their retrieval later.
MojoReporter() - Constructor for class org.thewonderlemming.c4plantuml.mojo.MojoReporter
 

N

NoDuplicateRelationships - Class in org.thewonderlemming.c4plantuml.mojo.linting
A simple POJO to enforce typing for the NoDuplicateRelationshipsRule parameters in the pom.xml.
NoDuplicateRelationships() - Constructor for class org.thewonderlemming.c4plantuml.mojo.linting.NoDuplicateRelationships
 
NoDuplicateRelationshipsRuleParametersFactory - Class in org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters
An implementation of AbstractRuleParametersFactory for the NoDuplicateRelationshipsRule.
NoDuplicateRelationshipsRuleParametersFactory(BuiltInRules) - Constructor for class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.NoDuplicateRelationshipsRuleParametersFactory
Default constructor.
NoOrphanAliasInBoundaries - Class in org.thewonderlemming.c4plantuml.mojo.linting
A simple POJO to enforce typing for the NoOrphanAliasInBoundariesRule parameters in the pom.xml.
NoOrphanAliasInBoundaries() - Constructor for class org.thewonderlemming.c4plantuml.mojo.linting.NoOrphanAliasInBoundaries
 
NoOrphanAliasInBoundariesRuleParametersFactory - Class in org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters
An implementation of AbstractRuleParametersFactory for the NoOrphanAliasInBoundariesRule.
NoOrphanAliasInBoundariesRuleParametersFactory(BuiltInRules) - Constructor for class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.NoOrphanAliasInBoundariesRuleParametersFactory
Default constructor.
NoOrphanAliasInLayouts - Class in org.thewonderlemming.c4plantuml.mojo.linting
A simple POJO to enforce typing for the NoOrphanAliasInLayoutsRule parameters in the pom.xml.
NoOrphanAliasInLayouts() - Constructor for class org.thewonderlemming.c4plantuml.mojo.linting.NoOrphanAliasInLayouts
 
NoOrphanAliasInLayoutsRuleParametersFactory - Class in org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters
An implementation of AbstractRuleParametersFactory for the NoOrphanAliasInLayoutsRule.
NoOrphanAliasInLayoutsRuleParametersFactory(BuiltInRules) - Constructor for class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.NoOrphanAliasInLayoutsRuleParametersFactory
Default constructor.
NoOrphanAliasInRelationships - Class in org.thewonderlemming.c4plantuml.mojo.linting
A simple POJO to enforce typing for the NoOrphanAliasInRelationshipsRule parameters in the pom.xml.
NoOrphanAliasInRelationships() - Constructor for class org.thewonderlemming.c4plantuml.mojo.linting.NoOrphanAliasInRelationships
 
NoOrphanAliasInRelationshipsRuleParametersFactory - Class in org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters
An implementation of AbstractRuleParametersFactory for the NoOrphanAliasInRelationshipsRule.
NoOrphanAliasInRelationshipsRuleParametersFactory(BuiltInRules) - Constructor for class org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters.NoOrphanAliasInRelationshipsRuleParametersFactory
Default constructor.

O

org.thewonderlemming.c4plantuml.mojo - package org.thewonderlemming.c4plantuml.mojo
Contains most of the MOJOs and their shared classes.
org.thewonderlemming.c4plantuml.mojo.linting - package org.thewonderlemming.c4plantuml.mojo.linting
Contains the LintingMojo and its dependencies used to type the parameters in the pom.xml configuration..
org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin - package org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin
Contains a set of factory classes to integrate AbstractLintingRule to the plugin.
org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters - package org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.parameters
Contains AbstractRuleParametersFactory implementations for built-in rules.
org.thewonderlemming.c4plantuml.mojo.linting.rules.custom - package org.thewonderlemming.c4plantuml.mojo.linting.rules.custom
Contains the foundation to build custom AbstractLintingRule - i.e.
OUTPUT_FILENAME_DEFAULT_VALUE - Static variable in class org.thewonderlemming.c4plantuml.mojo.ReportingMojo
Default value for the generated GraphML filename.

P

processOutputDirectoryFiles(Consumer<Path>) - Method in class org.thewonderlemming.c4plantuml.mojo.AbstractParentMojo
An utility method that enables the processing of the C4 PlantUML sources in the output directory.

R

report(String) - Method in class org.thewonderlemming.c4plantuml.mojo.MojoReporter
ReportingMojo - Class in org.thewonderlemming.c4plantuml.mojo
A MOJO that parses the C4 PlantUML files that are contained in the output directory and generates a GraphML file with the gathered information.
ReportingMojo() - Constructor for class org.thewonderlemming.c4plantuml.mojo.ReportingMojo
 

S

setActivated(boolean) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.AliasesShouldBeListedInDictionary
A simple setter for the isActivated property.
setActivated(boolean) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.AliasesShouldBeUnique
A simple setter for the isActivated property.
setActivated(boolean) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.AliasesShouldFollowStandardConvention
A simple setter for the isActivated property.
setActivated(boolean) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.NoDuplicateRelationships
A simple setter for the isActivated property.
setActivated(boolean) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.NoOrphanAliasInBoundaries
A simple setter for the isActivated property.
setActivated(boolean) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.NoOrphanAliasInLayouts
A simple setter for the isActivated property.
setActivated(boolean) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.NoOrphanAliasInRelationships
A simple setter for the isActivated property.
setAliasDefaultFormatRegex(String) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.AliasesShouldFollowStandardConvention
A simple setter for the aliasDefaultFormatRegex property.
setAliasDictionaryFilename(String) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.AliasesShouldBeListedInDictionary
A simple setter for the aliasDictionaryFilename property.
setAliasesShouldBeListedInDictionary(AliasesShouldBeListedInDictionary) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.BuiltInRules
A simple setter for the aliasesShouldBeListedInDictionary property.
setAliasesShouldBeUnique(AliasesShouldBeUnique) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.BuiltInRules
A simple setter for the aliasesShouldBeUnique property.
setAliasesShouldFollowStandardConvention(AliasesShouldFollowStandardConvention) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.BuiltInRules
A simple setter for the aliasesShouldFollowStandardConvention property.
setNoDuplicateRelationships(NoDuplicateRelationships) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.BuiltInRules
A simple setter for the noDuplicateRelationships property.
setNoOrphanAliasInBoundaries(NoOrphanAliasInBoundaries) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.BuiltInRules
A simple setter for the noOrphanAliasInBoundaries property.
setNoOrphanAliasInLayouts(NoOrphanAliasInLayouts) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.BuiltInRules
A simple setter for the noOrphanAliasInLayouts property.
setNoOrphanAliasInRelationships(NoOrphanAliasInRelationships) - Method in class org.thewonderlemming.c4plantuml.mojo.linting.BuiltInRules
A simple setter for the noOrphanAliasInRelationships property.
SyntaxCheckingMojo - Class in org.thewonderlemming.c4plantuml.mojo
A MOJO that parses the C4 PlantUML that are contained in the output directory and breaks the build if any syntax error is detected.
SyntaxCheckingMojo() - Constructor for class org.thewonderlemming.c4plantuml.mojo.SyntaxCheckingMojo
 

V

validateSourceFileExtension() - Method in class org.thewonderlemming.c4plantuml.mojo.AbstractParentMojo
Validates that the current sourceFileExtension property has a correct value, or sets it to the default value and displays an error message.
valueOf(String) - Static method in enum org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.BuiltInLintingRulesFactory
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.thewonderlemming.c4plantuml.mojo.linting.rules.builtin.BuiltInLintingRulesFactory
Returns an array containing the constants of this enum type, in the order they are declared.

W

WATERMARK_FORMAT_STRING - Static variable in class org.thewonderlemming.c4plantuml.mojo.WatermarkingMojo
Watermark string pattern.
WatermarkingMojo - Class in org.thewonderlemming.c4plantuml.mojo
A MOJO that adds a watermark to the C4 PlantUML files that are contained in the output directory, allowing the generated schemas to hold information on the generation date, the build version and so on.
WatermarkingMojo() - Constructor for class org.thewonderlemming.c4plantuml.mojo.WatermarkingMojo
 
A B C D E F G I L M N O P R S V W 
Skip navigation links

Copyright © 2020. All rights reserved.