umlet:convert

Full name:

com.kryshchuk.maven.plugins:umlet-maven-plugin:1.1.6:convert

Description:

Converts the UMLet UXF diagrams into the graphics files.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 1.0.0.
  • Binds by default to the lifecycle phase: pre-site.

Required Parameters

Name Type Since Description
format ConvertFormat 1.0.0 Convert diagram to this image format. Supported formats are bmp, eps, gif, jpg, pdf, png and svg.
Default value is: png.
User property is: umlet.format.
outputDirectory File 1.0.0 Target directory to store the converted images. If the source directory contains the sub-directories with diagram sources the generated image files will be created in the same sub-directories under the target directory. For example, the diagram sourceDirectory/overview.uxf will be converted into outputDirectory/overview.png, and the directory sourceDirectory/sub1/sub2/details.uxf will be converted into outputDirectory/sub1/sub2/details.png
Default value is: ${project.reporting.outputDirectory}/uml.
User property is: umlet.targetDir.

Optional Parameters

Name Type Since Description
filesets List 1.0.0 (no description)

Parameter Details

filesets:

(no description)
  • Type: java.util.List
  • Since: 1.0.0
  • Required: No

format:

Convert diagram to this image format. Supported formats are bmp, eps, gif, jpg, pdf, png and svg.
  • Type: com.kryshchuk.maven.plugins.umlet.ConvertFormat
  • Since: 1.0.0
  • Required: Yes
  • User Property: umlet.format
  • Default: png

outputDirectory:

Target directory to store the converted images. If the source directory contains the sub-directories with diagram sources the generated image files will be created in the same sub-directories under the target directory. For example, the diagram sourceDirectory/overview.uxf will be converted into outputDirectory/overview.png, and the directory sourceDirectory/sub1/sub2/details.uxf will be converted into outputDirectory/sub1/sub2/details.png
  • Type: java.io.File
  • Since: 1.0.0
  • Required: Yes
  • User Property: umlet.targetDir
  • Default: ${project.reporting.outputDirectory}/uml