de.elnarion.maven.plugin.plantuml.generator

Class PlantUMLGeneratorMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

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 org.apache.maven.plugin.AbstractMojo

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 and Description
PlantUMLGeneratorMojo()

Method Summary

Modifier and Type	Method and Description
void	execute() Execute.
String	getAsciidocDiagramBlockDelimiter() Gets the asciidoc diagram block delimiter.
String	getAsciidocDiagramImageFormat() Gets the asciidoc diagram image type.
String	getAsciidocDiagramName() Gets the asciidoc diagram name.
String	getBlacklistRegexp() Gets the blacklist regexp.
org.apache.maven.plugin.descriptor.PluginDescriptor	getDescriptor() Gets the descriptor.
String	getEncoding() Gets the encoding.
List<String>	getHideClasses() Gets the hide classes.
File	getOutputDirectory() Gets the output directory.
String	getOutputFilename() Gets the output filename.
org.apache.maven.project.MavenProject	getProject() Gets the project.
List<String>	getScanPackages() Gets the scan packages.
String	getWhitelistRegexp() Gets the whitelist regexp.
boolean	isEnableAsciidocWrapper() Checks if is enable asciidoc wrapper.
boolean	isHideFields() Checks if is hide fields.
boolean	isHideMethods() Checks if is hide methods.
void	setAsciidocDiagramBlockDelimiter(String asciidocDiagramBlockDelimiter) Sets the asciidoc diagram block delimiter.
void	setAsciidocDiagramImageFormat(String asciidocDiagramImageFormat) Sets the asciidoc diagram image type.
void	setAsciidocDiagramName(String asciidocDiagramName) Sets the asciidoc diagram name.
void	setBlacklistRegexp(String blacklistRegexp) Sets the blacklist regexp.
void	setDescriptor(org.apache.maven.plugin.descriptor.PluginDescriptor descriptor) Sets the descriptor.
void	setEnableAsciidocWrapper(boolean enableAsciidocWrapper) Sets the enable asciidoc wrapper.
void	setEncoding(String encoding) Sets the encoding.
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	setOutputDirectory(File outputDirectory) Sets the output directory.
void	setOutputFilename(String outputFilename) Sets the output filename.
void	setProject(org.apache.maven.project.MavenProject project) Sets the project.
void	setScanPackages(List<String> scanPackages) Sets the scan packages.
void	setWhitelistRegexp(String whitelistRegexp) Sets the whitelist regexp.

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 Detail

PlantUMLGeneratorMojo

public PlantUMLGeneratorMojo()

Method Detail

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

getEncoding

public String getEncoding()

Gets the encoding.

Returns:

String - the encoding

setEncoding

public void setEncoding(String encoding)

Sets the encoding.

Parameters:

encoding - the encoding

getOutputDirectory

public File getOutputDirectory()

Gets the output directory.

Returns:

File - the output directory

setOutputDirectory

public void setOutputDirectory(File outputDirectory)

Sets the output directory.

Parameters:

outputDirectory - the output directory

getOutputFilename

public String getOutputFilename()

Gets the output filename.

Returns:

String - the output filename

setOutputFilename

public void setOutputFilename(String outputFilename)

Sets the output filename.

Parameters:

outputFilename - the output filename

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

getDescriptor

public org.apache.maven.plugin.descriptor.PluginDescriptor getDescriptor()

Gets the descriptor.

Returns:

PluginDescriptor - the descriptor

setDescriptor

public void setDescriptor(org.apache.maven.plugin.descriptor.PluginDescriptor descriptor)

Sets the descriptor.

Parameters:

descriptor - the descriptor

getProject

public org.apache.maven.project.MavenProject getProject()

Gets the project.

Returns:

MavenProject - the project

setProject

public void setProject(org.apache.maven.project.MavenProject project)

Sets the project.

Parameters:

project - the project

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

isEnableAsciidocWrapper

public boolean isEnableAsciidocWrapper()

Checks if is enable asciidoc wrapper.

Returns:

true, if is enable asciidoc wrapper

setEnableAsciidocWrapper

public void setEnableAsciidocWrapper(boolean enableAsciidocWrapper)

Sets the enable asciidoc wrapper.

Parameters:

enableAsciidocWrapper - the new enable asciidoc wrapper

getAsciidocDiagramName

public String getAsciidocDiagramName()

Gets the asciidoc diagram name.

Returns:

the asciidoc diagram name

setAsciidocDiagramName

public void setAsciidocDiagramName(String asciidocDiagramName)

Sets the asciidoc diagram name.

Parameters:

asciidocDiagramName - the new asciidoc diagram name

getAsciidocDiagramImageFormat

public String getAsciidocDiagramImageFormat()

Gets the asciidoc diagram image type.

Returns:

the asciidoc diagram image type

setAsciidocDiagramImageFormat

public void setAsciidocDiagramImageFormat(String asciidocDiagramImageFormat)

Sets the asciidoc diagram image type.

Parameters:

asciidocDiagramImageFormat - the new asciidoc diagram image type

getAsciidocDiagramBlockDelimiter

public String getAsciidocDiagramBlockDelimiter()

Gets the asciidoc diagram block delimiter.

Returns:

the asciidoc diagram block delimiter

setAsciidocDiagramBlockDelimiter

public void setAsciidocDiagramBlockDelimiter(String asciidocDiagramBlockDelimiter)

Sets the asciidoc diagram block delimiter.

Parameters:

asciidocDiagramBlockDelimiter - the new asciidoc diagram block delimiter