Module com.semanticcms.tagreference

Package com.semanticcms.tagreference

Class LinkedSignatureTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

com.semanticcms.tagreference.LinkedSignatureTag

All Implemented Interfaces:

Serializable, IterationTag, JspTag, Tag

public class LinkedSignatureTag
extends TagSupport

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

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

See Also:

• Serialized Form

Field Summary

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor	Description
LinkedSignatureTag()

Method Summary

Modifier and Type	Method	Description
int	doStartTag()
void	setApiLinks(Map<String,String> apiLinks)
void	setRequireLinks(boolean requireLinks)
void	setShortName(boolean shortName)
void	setSignature(String signature)
static void	writeLinkedSignature(PageContext pageContext, boolean requireLinks, Map<String,String> apiLinks, String signature, boolean shortName, Appendable out)

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LinkedSignatureTag

public LinkedSignatureTag()

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.

setShortName

public void setShortName(boolean shortName)

Parameters:

shortName - When true, will display class names in short format. Defaults to false.

writeLinkedSignature

public static void writeLinkedSignature(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