Package nl.talsmasoftware.umldoclet.configuration

Interface FieldConfig

public interface FieldConfig
Influences how Fields are rendered in the UML.
Author:
Sjoerd Talsma

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    include​(Visibility fieldVisibility)
    Return whether to include fields with the specified Visibility into the UML diagram.
    TypeDisplay
    typeDisplay()
    How to display the type of the field in the UML diagram (if included).

  • Method Details

    • typeDisplay

      TypeDisplay typeDisplay()
      How to display the type of the field in the UML diagram (if included). Possible values how to display field types are summarized in the TypeDisplay description.
      Returns:
      the configured way of displaying the types for fields in the UML diagram.

    • include

      boolean include​(Visibility fieldVisibility)
      Return whether to include fields with the specified Visibility into the UML diagram.
      Parameters:
      fieldVisibility - The disibility of the field evaluated for inclusion in the UML diagram.
      Returns:
      true if fields with the requested visibility should be included in the UML diagram or false otherwise.