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

Class AbstractPlantUMLGeneratorMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
de.elnarion.maven.plugin.plantuml.generator.AbstractPlantUMLGeneratorMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
Direct Known Subclasses:
PlantUMLGeneratorMojo, PlantUMLSequenceDiagramGeneratorMojo
public abstract class AbstractPlantUMLGeneratorMojo extends org.apache.maven.plugin.AbstractMojo
The Class AbstractPlantUMLGeneratorMojo.

  • Constructor Details

    • AbstractPlantUMLGeneratorMojo

      public AbstractPlantUMLGeneratorMojo()

  • Method Details

    • createAsciidocWrappedDiagramText

      protected String createAsciidocWrappedDiagramText(String paramClassDiagramTextToWrap)
      Wraps a plantuml diagram text by an asciidoc diagram block.
      Parameters:
      paramClassDiagramTextToWrap - the class diagram text
      Returns:
      the asciidoc plantuml diagram block

    • createMarkdownWrappedDiagramText

      protected String createMarkdownWrappedDiagramText(String paramClassDiagramTextToWrap)
      Wraps a plantuml diagram text by an markdown diagram block.
      Parameters:
      paramClassDiagramTextToWrap - the class diagram text
      Returns:
      the markdown plantuml diagram block

    • writeDiagramToFile

      protected void writeDiagramToFile(String classDiagramText) throws IOException
      Write diagram to file.
      Parameters:
      classDiagramText - the class diagram text
      Throws:
      IOException - Signals that an I/O exception has occurred.

    • getCompileClassLoader

      protected ClassLoader getCompileClassLoader() throws org.apache.maven.plugin.MojoExecutionException
      Gets the compile class loader.
      Returns:
      ClassLoader - the compile class loader
      Throws:
      org.apache.maven.plugin.MojoExecutionException - the mojo execution 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

    • 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

    • 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

    • isEnableMarkdowncWrapper

      public boolean isEnableMarkdowncWrapper()
      Checks if is enable markdown wrapper.
      Returns:
      true, if is enable markdown wrapper

    • setEnableMarkdownWrapper

      public void setEnableMarkdownWrapper(boolean enableMarkdownWrapper)
      Sets the enable markdown wrapper.
      Parameters:
      enableMarkdownWrapper - the new enable markdown 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

    • getAdditionalPlantUmlConfigs

      public List<String> getAdditionalPlantUmlConfigs()
      Gets the additional plant uml configs.
      Returns:
      the additional plant uml configs

    • setAdditionalPlantUmlConfigs

      public void setAdditionalPlantUmlConfigs(List<String> additionalPlantUmlConfigs)
      Sets the additional plant uml configs.
      Parameters:
      additionalPlantUmlConfigs - the new additional plant uml configs