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

Class PlantUMLSequenceDiagramGeneratorMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

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

de.elnarion.maven.plugin.plantuml.generator.PlantUMLSequenceDiagramGeneratorMojo

All Implemented Interfaces:

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

@Mojo(name="generateSequenceDiagram",
      defaultPhase=GENERATE_SOURCES,
      threadSafe=true,
      requiresDependencyResolution=COMPILE,
      requiresProject=true)
public class PlantUMLSequenceDiagramGeneratorMojo
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
PlantUMLSequenceDiagramGeneratorMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()	Execute.
String	getClassBlacklistRegexp()	Gets the class blacklist regexp.
String	getMethodBlacklistRegexp()	Gets the method blacklist regexp.
String	getStartClass()	Gets the start class.
String	getStartMethod()	Gets the start method.
boolean	isHideMethodName()	Checks if is hide method name.
boolean	isHideSuperClass()	Checks if is hide super class.
boolean	isIgnoreJPAEntities()	Checks if is ignore JPA entities.
boolean	isIgnoreStandardClasses()	Checks if is ignore standard classes.
boolean	isShowReturnTypes()	Checks if is show return types.
boolean	isUseShortClassNames()	Checks if is use short class names.
void	setClassBlacklistRegexp(String classBlacklistRegexp)	Sets the class blacklist regexp.
void	setHideMethodName(boolean hideMethodName)	Sets the hide method name.
void	setHideSuperClass(boolean hideSuperClass)	Sets the hide super class.
void	setIgnoreJPAEntities(boolean ignoreJPAEntities)	Sets the ignore JPA entities.
void	setIgnoreStandardClasses(boolean ignoreStandardClasses)	Sets the ignore standard classes.
void	setMethodBlacklistRegexp(String methodBlacklistRegexp)	Sets the method blacklist regexp.
void	setShowReturnTypes(boolean showReturnTypes)	Sets the show return types.
void	setStartClass(String startClass)	Sets the start class.
void	setStartMethod(String startMethod)	Sets the start method.
void	setUseShortClassNames(boolean useShortClassNames)	Sets the use short class names.

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

PlantUMLSequenceDiagramGeneratorMojo

public PlantUMLSequenceDiagramGeneratorMojo()

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

getClassBlacklistRegexp

public String getClassBlacklistRegexp()

Gets the class blacklist regexp.

Returns:

the class blacklist regexp

setClassBlacklistRegexp

public void setClassBlacklistRegexp(String classBlacklistRegexp)

Sets the class blacklist regexp.

Parameters:

classBlacklistRegexp - the new class blacklist regexp

isHideMethodName

public boolean isHideMethodName()

Checks if is hide method name.

Returns:

true, if is hide method name

setHideMethodName

public void setHideMethodName(boolean hideMethodName)

Sets the hide method name.

Parameters:

hideMethodName - the new hide method name

isHideSuperClass

public boolean isHideSuperClass()

Checks if is hide super class.

Returns:

true, if is hide super class

setHideSuperClass

public void setHideSuperClass(boolean hideSuperClass)

Sets the hide super class.

Parameters:

hideSuperClass - the new hide super class

isIgnoreJPAEntities

public boolean isIgnoreJPAEntities()

Checks if is ignore JPA entities.

Returns:

true, if is ignore JPA entities

setIgnoreJPAEntities

public void setIgnoreJPAEntities(boolean ignoreJPAEntities)

Sets the ignore JPA entities.

Parameters:

ignoreJPAEntities - the new ignore JPA entities

isIgnoreStandardClasses

public boolean isIgnoreStandardClasses()

Checks if is ignore standard classes.

Returns:

true, if is ignore standard classes

setIgnoreStandardClasses

public void setIgnoreStandardClasses(boolean ignoreStandardClasses)

Sets the ignore standard classes.

Parameters:

ignoreStandardClasses - the new ignore standard classes

getMethodBlacklistRegexp

public String getMethodBlacklistRegexp()

Gets the method blacklist regexp.

Returns:

the method blacklist regexp

setMethodBlacklistRegexp

public void setMethodBlacklistRegexp(String methodBlacklistRegexp)

Sets the method blacklist regexp.

Parameters:

methodBlacklistRegexp - the new method blacklist regexp

isShowReturnTypes

public boolean isShowReturnTypes()

Checks if is show return types.

Returns:

true, if is show return types

setShowReturnTypes

public void setShowReturnTypes(boolean showReturnTypes)

Sets the show return types.

Parameters:

showReturnTypes - the new show return types

isUseShortClassNames

public boolean isUseShortClassNames()

Checks if is use short class names.

Returns:

true, if is use short class names

setUseShortClassNames

public void setUseShortClassNames(boolean useShortClassNames)

Sets the use short class names.

Parameters:

useShortClassNames - the new use short class names

getStartClass

public String getStartClass()

Gets the start class.

Returns:

the start class

setStartClass

public void setStartClass(String startClass)

Sets the start class.

Parameters:

startClass - the new start class

getStartMethod

public String getStartMethod()

Gets the start method.

Returns:

the start method

setStartMethod

public void setStartMethod(String startMethod)

Sets the start method.

Parameters:

startMethod - the new start method