Package nl.talsmasoftware.umldoclet.configuration

Interface Configuration

All Known Implementing Classes:
DocletConfig
public interface Configuration
Configuration that influences how UML should be rendered.
Author:
Sjoerd Talsma

  • Method Details

    • delegateDocletName

      Optional<String> delegateDocletName()
      Returns:
      The name of the doclet to delegate main documentation to or Optional.empty() if no delegation is wanted.

    • logger

      Logger logger()
      Custom logger implementation that only supports fixed messages.

      This allows us to write unit tests that verify resource bundle availability of all loggable text.

      Returns:
      The logger for this application

    • indentation

      Indentation indentation()
      Returns:
      The configured indentation within the generated UML files.

    • destinationDirectory

      String destinationDirectory()
      Returns:
      The destination directory for the UML diagrams, or the empty string "" for the current directory.

    • renderPumlFile

      boolean renderPumlFile()
      Returns:
      Whether or not to render PlantUML .puml files.

    • images

      ImageConfig images()
      Returns:
      The configuration for the images that are generated.

    • fields

      FieldConfig fields()
      Returns:
      The part of the configuration that determines how fields are rendered.

    • methods

      MethodConfig methods()
      Returns:
      The part of the configuration that determines how methods are rendered.

    • excludedTypeReferences

      List<String> excludedTypeReferences()
      Returns:
      The types (classes, interfaces) that are excluded as references.

    • excludedPackageDependencies

      List<String> excludedPackageDependencies()
      Returns:
      The packages (including subpackages) excluded from the package dependencies.

    • failOnCyclicPackageDependencies

      boolean failOnCyclicPackageDependencies()
      Returns:
      Whether or not to fail when cyclic package dependencies are detected.

    • resolveExternalLinkToType

      Optional<URI> resolveExternalLinkToType​(String packageName, String type)
      Resolves an external link to the specified type.
      Parameters:
      packageName - The package of the type.
      type - The type name within the package.
      Returns:
      The external link, if resolved

    • customPlantumlDirectives

      List<String> customPlantumlDirectives()
      Custom directives to include in rendered PlantUML diagram sources.

      Custom directives are rendered as-is at the top of each PlantUML diagram. For example, to use jdot for rendering, use the "!pragma graphviz_dot jdot" custom directive.

      Returns:
      Any custom PlantUML directives.

    • umlCharset

      Charset umlCharset()
      The UML character set can be explicitly configured with the "-umlEncoding" option.

      If this is not explicitly set, the htmlCharset() will also be used for the PlantUML source files.

      Returns:
      The charset to use for PlantUML files

    • htmlCharset

      Charset htmlCharset()
      The HTML character set is determined the same way the Standard doclet uses, as we delegate the initial rendering to it:
      1. use the "-docencoding" if set,
      2. otherwise the source encoding ("-encoding")
      3. finally, if no encodings are specified at all, the default platform encoding is used as implicit fallback
      Returns:
      The charset used for Javadoc HTML files