Package com.github.plantuml.maven

Class PlantUMLMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
com.github.plantuml.maven.PlantUMLMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
@Mojo(defaultPhase=GENERATE_RESOURCES,
      name="generate")
public final class PlantUMLMojo
extends org.apache.maven.plugin.AbstractMojo

  • Field Summary

    Fields 
    Modifier and Type Field Description
    protected String charset
    Charset used during generation.
    protected String config
    External configuration file location.
    protected String format
    Specify output format.
    protected String graphvizDot
    Fully qualified path to Graphviz home directory.
    protected net.sourceforge.plantuml.Option option  
    protected File outputDirectory
    Directory where generated images are generated.
    protected boolean outputInSourceDirectory
    Whether or not to generate images in same directory as the source file.
    protected boolean overwrite
    Specify to overwrite any output file, also if the target file is newer as the input file.
    protected org.apache.maven.model.FileSet sourceFiles
    Fileset to search plantuml diagrams in.
    protected String truncatePattern
    Truncate the ouput folder.
    protected boolean verbose
    Wether or not to output details during generation.
    protected boolean withMetadata
    Specify to include metadata in the output files.

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

    ROLE

  • Constructor Summary

    Constructors 
    Constructor Description
    PlantUMLMojo()  

  • Method Summary

    Modifier and Type Method Description
    void execute()  
    protected String getCommaSeparatedList​(List<String> list)  
    protected net.sourceforge.plantuml.FileFormatOption getFileFormatOption()  
    protected void setFormat​(String format)  

    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

  • Field Details

    • option

      protected final net.sourceforge.plantuml.Option option

    • truncatePattern

      @Parameter(property="truncatePattern") protected String truncatePattern
      Truncate the ouput folder.
      Since:
      1.2

    • sourceFiles

      @Parameter(property="plantuml.sourceFiles", required=true) protected org.apache.maven.model.FileSet sourceFiles
      Fileset to search plantuml diagrams in.
      Since:
      7232

    • outputDirectory

      @Parameter(property="plantuml.outputDirectory", defaultValue="${basedir}/target/plantuml", required=true) protected File outputDirectory
      Directory where generated images are generated.

    • outputInSourceDirectory

      @Parameter(property="plantuml.outputInSourceDirectory", defaultValue="false") protected boolean outputInSourceDirectory
      Whether or not to generate images in same directory as the source file. This is useful for using PlantUML diagrams in Javadoc, as described here: http://plantuml. sourceforge.net/javadoc.html.

      If this is set to true then outputDirectory is ignored.

    • charset

      @Parameter(property="plantuml.charset") protected String charset
      Charset used during generation.

    • config

      @Parameter(property="plantuml.config") protected String config
      External configuration file location.

    • format

      @Parameter(property="plantuml.format") protected String format
      Specify output format. Supported values: xmi, xmi:argo, xmi:start, eps, pdf, eps:txt, svg, png, dot, txt and utxt.

    • graphvizDot

      @Parameter(property="plantuml.graphvizDot") protected String graphvizDot
      Fully qualified path to Graphviz home directory.

    • verbose

      @Parameter(property="plantuml.verbose", defaultValue="false") protected boolean verbose
      Wether or not to output details during generation.

    • withMetadata

      @Parameter(property="plantuml.withMetadata") protected boolean withMetadata
      Specify to include metadata in the output files.
      Since:
      1.3

    • overwrite

      @Parameter(property="plantuml.overwrite") protected boolean overwrite
      Specify to overwrite any output file, also if the target file is newer as the input file.
      Since:
      1.3

  • Constructor Details

  • Method Details