Class LinkedSignatureReturnTag

java.lang.Object
javax.servlet.jsp.tagext.TagSupport
com.semanticcms.tagreference.LinkedSignatureReturnTag
All Implemented Interfaces:
Serializable, IterationTag, JspTag, Tag

public class LinkedSignatureReturnTag extends TagSupport

Displays a function or method signature return type, possibly linked to javadocs apis.

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

See Also:
  • Constructor Details

    • LinkedSignatureReturnTag

      public LinkedSignatureReturnTag()
  • Method Details

    • 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 return type of.
    • setShortName

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

      public static void writeLinkedSignatureReturn(PageContext pageContext, boolean requireLinks, Map<String,String> apiLinks, String signature, boolean shortName, Appendable out) throws IOException, JspTagException
      Throws:
      IOException
      JspTagException
    • doStartTag

      public int doStartTag() throws JspException
      Specified by:
      doStartTag in interface Tag
      Overrides:
      doStartTag in class TagSupport
      Throws:
      JspException