Package nl.talsmasoftware.umldoclet.configuration

Interface MethodConfig

public interface MethodConfig
Influences how Methods are rendered in the UML.
Author:
Sjoerd Talsma

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    MethodConfig.ParamNames
    How parameter names must be rendered.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    include(Visibility methodVisibility)
    Return whether the method with specified visibility should be included in the UML diagram.
    boolean
    javaBeanPropertiesAsFields()
    Whether JavaBean property accessor methods such as getXyz(), isXyz(), setXyz(Xyz xyz) should be rendered as Fields in UML.
    MethodConfig.ParamNames
    paramNames()
    How method parameter names must be rendered.
    TypeDisplay
    paramTypes()
    How parameter types must be rendered.
    TypeDisplay
    returnType()
    How method return types must be rendered.

  • Method Details

    • paramNames

      MethodConfig.ParamNames paramNames()
      How method parameter names must be rendered.
      Returns:
      How method parameter names must be rendered.

    • paramTypes

      TypeDisplay paramTypes()
      How parameter types must be rendered.
      Returns:
      How parameter types must be rendered.

    • returnType

      TypeDisplay returnType()
      How method return types must be rendered.
      Returns:
      How method return types must be rendered.

    • include

      boolean include(Visibility methodVisibility)
      Return whether the method with specified visibility should be included in the UML diagram.
      Parameters:
      methodVisibility - The method visibility.
      Returns:
      true if the method should be included in the UML diagram based on its visibility, or false if it should be omitted.

    • javaBeanPropertiesAsFields

      boolean javaBeanPropertiesAsFields()
      Whether JavaBean property accessor methods such as getXyz(), isXyz(), setXyz(Xyz xyz) should be rendered as Fields in UML.
      Returns:
      true if JavaBean accessor methods should be rendered as Fields in the UML diagram, false to render them as normal methods.