Package nl.talsmasoftware.umldoclet.javadoc

Class DocletConfig

java.lang.Object
nl.talsmasoftware.umldoclet.javadoc.DocletConfig
All Implemented Interfaces:
Configuration
public class DocletConfig extends Object implements Configuration

  • Constructor Details

    • DocletConfig

      public DocletConfig()

  • Method Details

    • init

      public void init(Locale locale, Reporter reporter)

    • mergeOptionsWith

      public Set<Doclet.Option> mergeOptionsWith(Set<? extends Doclet.Option> standardOptions)

    • delegateDocletName

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

    • logger

      public Logger logger()
      Description copied from interface: Configuration
      Custom logger implementation that only supports fixed messages.

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

      Specified by:
      logger in interface Configuration
      Returns:
      The logger for this application

    • indentation

      public Indentation indentation()
      Specified by:
      indentation in interface Configuration
      Returns:
      The configured indentation within the generated UML files.

    • destinationDirectory

      public String destinationDirectory()
      Specified by:
      destinationDirectory in interface Configuration
      Returns:
      The destination directory for the UML diagrams, or the empty string "" for the current directory.

    • renderPumlFile

      public boolean renderPumlFile()
      Specified by:
      renderPumlFile in interface Configuration
      Returns:
      Whether or not to render PlantUML .puml files.

    • images

      public ImageConfig images()
      Specified by:
      images in interface Configuration
      Returns:
      The configuration for the images that are generated.

    • fields

      public FieldConfig fields()
      Specified by:
      fields in interface Configuration
      Returns:
      The part of the configuration that determines how fields are rendered.

    • methods

      public MethodConfig methods()
      Specified by:
      methods in interface Configuration
      Returns:
      The part of the configuration that determines how methods are rendered.

    • excludedTypeReferences

      public List<String> excludedTypeReferences()
      Specified by:
      excludedTypeReferences in interface Configuration
      Returns:
      The types (classes, interfaces) that are excluded as references.

    • excludedPackageDependencies

      public List<String> excludedPackageDependencies()
      Specified by:
      excludedPackageDependencies in interface Configuration
      Returns:
      The packages (including subpackages) excluded from the package dependencies.

    • failOnCyclicPackageDependencies

      public boolean failOnCyclicPackageDependencies()
      Specified by:
      failOnCyclicPackageDependencies in interface Configuration
      Returns:
      Whether or not to fail when cyclic package dependencies are detected.

    • resolveExternalLinkToType

      public Optional<URI> resolveExternalLinkToType(String packageName, String type)
      Description copied from interface: Configuration
      Resolves an external link to the specified type.
      Specified by:
      resolveExternalLinkToType in interface Configuration
      Parameters:
      packageName - The package of the type.
      type - The type name within the package.
      Returns:
      The external link, if resolved

    • customPlantumlDirectives

      public List<String> customPlantumlDirectives()
      Description copied from interface: Configuration
      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.

      Specified by:
      customPlantumlDirectives in interface Configuration
      Returns:
      Any custom PlantUML directives.

    • umlCharset

      public Charset umlCharset()
      Description copied from interface: Configuration
      The UML character set can be explicitly configured with the "-umlEncoding" option.

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

      Specified by:
      umlCharset in interface Configuration
      Returns:
      The charset to use for PlantUML files

    • htmlCharset

      public Charset htmlCharset()
      Description copied from interface: Configuration
      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
      Specified by:
      htmlCharset in interface Configuration
      Returns:
      The charset used for Javadoc HTML files