Module com.aoapps.tldparser

Package com.aoapps.tldparser

Class Function

java.lang.Object

com.aoapps.tldparser.Function

public class Function
extends Object

Models one function within the *.tld file.

TLD files may provide generics within special comments inside the XML, where the value must match function-signature, but with the addition of <…> segments.

<!-- functionSignature = "…" -->

Constructor Summary

Constructors

Constructor	Description
Function(String summaryClass, Taglib taglib, Element functionElem)
Function(String summaryClass, Taglib taglib, Element functionElem, Map<String,String> apiLinks)	Deprecated. apiLinks is unused, please use Function(java.lang.String, com.aoapps.tldparser.Taglib, org.w3c.dom.Element) instead.

Method Summary

Modifier and Type	Method	Description
Boolean	getAllowRobots()
Dates	getDates()
List<String>	getDescriptions()
String	getDescriptionSummary()	Gets a summary of the description.
List<String>	getDisplayNames()
String	getExample()
String	getFunctionClass()
String	getFunctionSignature()
String	getName()
Taglib	getTaglib()

Methods inherited from class java.lang.Object

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

Constructor Detail

Function

public Function(String summaryClass,
                Taglib taglib,
                Element functionElem)
         throws ParserConfigurationException,
                SAXException,
                IOException,
                XPathExpressionException

Throws:

ParserConfigurationException

SAXException

IOException

XPathExpressionException

Function

@Deprecated
public Function(String summaryClass,
                Taglib taglib,
                Element functionElem,
                Map<String,String> apiLinks)
         throws ParserConfigurationException,
                SAXException,
                IOException,
                XPathExpressionException

Deprecated.

apiLinks is unused, please use Function(java.lang.String, com.aoapps.tldparser.Taglib, org.w3c.dom.Element) instead.

Throws:

ParserConfigurationException

SAXException

IOException

XPathExpressionException

Method Detail

getTaglib

public Taglib getTaglib()

getDates

public Dates getDates()

getAllowRobots

public Boolean getAllowRobots()

getDescriptions

public List<String> getDescriptions()

getDisplayNames

public List<String> getDisplayNames()

getName

public String getName()

getFunctionClass

public String getFunctionClass()

getFunctionSignature

public String getFunctionSignature()

getExample

public String getExample()

getDescriptionSummary

public String getDescriptionSummary()

Gets a summary of the description. If there is more than once description, only the first is used in generating the summary. If there are no descriptions, returns null.

See Also:

HtmlSnippet.getSummary(java.lang.String, java.lang.String)