Class LinkedSignatureParamsTag

  • All Implemented Interfaces:
    Serializable, IterationTag, JspTag, Tag

    public class LinkedSignatureParamsTag
    extends TagSupport

    Displays function or method parameters including parentheses, possibly linked to javadocs apis.

    Supports arrays …[] and generics <…[, …]>, possibly nested.

    See Also:
    Serialized Form
    • Constructor Detail

      • LinkedSignatureParamsTag

        public LinkedSignatureParamsTag()
    • Method Detail

      • setRequireLinks

        public void setRequireLinks​(boolean requireLinks)
        Parameters:
        requireLinks - When true, will fail when a class does not map to a package in apiLinks. Defaults to false.
      • setApiLinks

        public void setApiLinks​(Map<String,​String> apiLinks)
        Parameters:
        apiLinks - The mapping of Java package name (with optional trailing '.') to javadoc prefixes (including trailing '/').
      • setSignature

        public void setSignature​(String signature)
        Parameters:
        signature - The signature to display the parameters of.
      • setShortName

        public void setShortName​(boolean shortName)
        Parameters:
        shortName - When true, will display class names in short format. Defaults to false.