Package de.elnarion.maven.plugin.plantuml.generator

Class PlantUMLGeneratorMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

de.elnarion.maven.plugin.plantuml.generator.AbstractPlantUMLGeneratorMojo

de.elnarion.maven.plugin.plantuml.generator.PlantUMLGeneratorMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="generate",
      defaultPhase=GENERATE_SOURCES,
      threadSafe=true,
      requiresDependencyResolution=COMPILE,
      requiresProject=true)
public class PlantUMLGeneratorMojo
extends AbstractPlantUMLGeneratorMojo

This Mojo is used as maven frontend of the PlantUMLClassDiagramGenerator in the artifact plantuml-generator-util.

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
PlantUMLGeneratorMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()	Execute.
String	getBlacklistRegexp()	Gets the blacklist regexp.
List<String>	getHideClasses()	Gets the hide classes.
List<String>	getScanPackages()	Gets the scan packages.
String	getWhitelistRegexp()	Gets the whitelist regexp.
boolean	isAddJavaxValidationAnnotations()	Checks if is adds the Javax Validation annotations.
boolean	isAddJPAAnnotations()	Checks if is adds the JPA annotations.
boolean	isHideFields()	Checks if is hide fields.
boolean	isHideMethods()	Checks if is hide methods.
boolean	isUseSmetana()	Checks if Smetana is enabled.
void	setAddJavaxValidationAnnotations(boolean addJavaxValidationAnnotations)	Sets the adds the Javax Validation annotations.
void	setAddJPAAnnotations(boolean addJPAAnnotations)	Sets the adds the JPA annotations.
void	setBlacklistRegexp(String blacklistRegexp)	Sets the blacklist regexp.
void	setHideClasses(List<String> hideClasses)	Sets the hide classes.
void	setHideFields(boolean hideFields)	Sets the hide fields.
void	setHideMethods(boolean hideMethods)	Sets the hide methods.
void	setScanPackages(List<String> scanPackages)	Sets the scan packages.
void	setUseSmetana(boolean useSmetana)	Sets the Smetana.
void	setWhitelistRegexp(String whitelistRegexp)	Sets the whitelist regexp.

Methods inherited from class de.elnarion.maven.plugin.plantuml.generator.AbstractPlantUMLGeneratorMojo

createAsciidocWrappedDiagramText, createMarkdownWrappedDiagramText, getAdditionalPlantUmlConfigs, getAsciidocDiagramBlockDelimiter, getAsciidocDiagramImageFormat, getAsciidocDiagramName, getCompileClassLoader, getDescriptor, getEncoding, getOutputDirectory, getOutputFilename, getProject, isEnableAsciidocWrapper, isEnableMarkdowncWrapper, setAdditionalPlantUmlConfigs, setAsciidocDiagramBlockDelimiter, setAsciidocDiagramImageFormat, setAsciidocDiagramName, setDescriptor, setEnableAsciidocWrapper, setEnableMarkdownWrapper, setEncoding, setOutputDirectory, setOutputFilename, setProject, writeDiagramToFile

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Details

PlantUMLGeneratorMojo

public PlantUMLGeneratorMojo()

Method Details

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Execute.

Throws:

org.apache.maven.plugin.MojoExecutionException - the mojo execution exception

org.apache.maven.plugin.MojoFailureException - the mojo failure exception

isUseSmetana

public boolean isUseSmetana()

Checks if Smetana is enabled.

Returns:

true, enabled.

setUseSmetana

public void setUseSmetana(boolean useSmetana)

Sets the Smetana.

Parameters:

useSmetana - set use Smetana

isHideFields

public boolean isHideFields()

Checks if is hide fields.

Returns:

true, if is hide fields

setHideFields

public void setHideFields(boolean hideFields)

Sets the hide fields.

Parameters:

hideFields - the hide fields

isHideMethods

public boolean isHideMethods()

Checks if is hide methods.

Returns:

true, if is hide methods

setHideMethods

public void setHideMethods(boolean hideMethods)

Sets the hide methods.

Parameters:

hideMethods - the hide methods

getScanPackages

public List<String> getScanPackages()

Gets the scan packages.

Returns:

List - the scan packages

setScanPackages

public void setScanPackages(List<String> scanPackages)

Sets the scan packages.

Parameters:

scanPackages - the scan packages

getHideClasses

public List<String> getHideClasses()

Gets the hide classes.

Returns:

List - the hide classes

setHideClasses

public void setHideClasses(List<String> hideClasses)

Sets the hide classes.

Parameters:

hideClasses - the hide classes

getWhitelistRegexp

public String getWhitelistRegexp()

Gets the whitelist regexp.

Returns:

the whitelist regexp

setWhitelistRegexp

public void setWhitelistRegexp(String whitelistRegexp)

Sets the whitelist regexp.

Parameters:

whitelistRegexp - the new whitelist regexp

getBlacklistRegexp

public String getBlacklistRegexp()

Gets the blacklist regexp.

Returns:

the blacklist regexp

setBlacklistRegexp

public void setBlacklistRegexp(String blacklistRegexp)

Sets the blacklist regexp.

Parameters:

blacklistRegexp - the new blacklist regexp

isAddJPAAnnotations

public boolean isAddJPAAnnotations()

Checks if is adds the JPA annotations.

Returns:

true, if is adds the JPA annotations

setAddJPAAnnotations

public void setAddJPAAnnotations(boolean addJPAAnnotations)

Sets the adds the JPA annotations.

Parameters:

addJPAAnnotations - the new adds the JPA annotations

isAddJavaxValidationAnnotations

public boolean isAddJavaxValidationAnnotations()

Checks if is adds the Javax Validation annotations.

Returns:

true, if is adds the Javax Validation annotations

setAddJavaxValidationAnnotations

public void setAddJavaxValidationAnnotations(boolean addJavaxValidationAnnotations)

Sets the adds the Javax Validation annotations.

Parameters:

addJavaxValidationAnnotations - the new adds the Javax Validation annotations