Package nl.talsmasoftware.umldoclet.configuration

Interface MethodConfig

public interface MethodConfig
Configuration for UML method rendering.
Author:
Sjoerd Talsma

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    MethodConfig.ParamNames
    How method parameters are rendered.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    include(Visibility methodVisibility)
    Whether a method with given visibility must 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 are rendered.
    TypeDisplay
    paramTypes()
    How parameter types are rendered.
    TypeDisplay
    returnType()
    How method return types are rendered.

  • Method Details

    • paramNames

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

    • paramTypes

      TypeDisplay paramTypes()
      How parameter types are rendered.
      Returns:
      How parameter types are rendered.

    • returnType

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

    • include

      boolean include(Visibility methodVisibility)
      Whether a method with given visibility must be included in the UML diagram.
      Parameters:
      methodVisibility - The method visibility.
      Returns:
      true if the method must be included in the UML diagram based on its visibility, or false if it must 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.