Module com.aoapps.tldparser

Package com.aoapps.tldparser

Class Taglib

java.lang.Object

com.aoapps.tldparser.Taglib

public class Taglib
extends Object

Models the *.tld file overall.

TODO: Warn when using defaultDates?

TODO: When a taglib is expected to have all dates specified, disallow default dates and error instead?

TODO: Use a Callable to get defaultDates when first needed. This will avoid overhead when not needed.

TODO: Parse all elements and error if dates found in wrong places?

Constructor Summary

Constructors

Constructor	Description
Taglib(String summaryClass, String tldPath, Dates defaultDates, Document tldDoc)	Extracts the components of an XML-parsed *.tld file.
Taglib(String summaryClass, String tldPath, Dates defaultDates, Document tldDoc, Map<String,String> apiLinks)	Deprecated, for removal: This API element is subject to removal in a future version. apiLinks is unused, please use Taglib(java.lang.String, java.lang.String, com.aoapps.tldparser.Dates, org.w3c.dom.Document) instead.

Method Summary

Modifier and Type	Method	Description
Boolean	getAllowRobots()
Dates	getDates()
List<String>	getDescriptions()
List<String>	getDisplayNames()
Map<String,Function>	getFunction()
List<Function>	getFunctions()
Dates	getFunctionsEffectiveDates()	Gets the effective dates for the all functions.
String	getShortName()
Map<String,Tag>	getTag()
Dates	getTaglibEffectiveDates()	Gets the effective dates for the taglib overall, including itself along with all tags and functions.
List<Tag>	getTags()
Dates	getTagsEffectiveDates()	Gets the effective dates for the all tags.
String	getTldPath()
String	getTlibVersion()
String	getUri()

Methods inherited from class java.lang.Object

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

Constructor Details

Taglib

public Taglib(String summaryClass,
 String tldPath,
 Dates defaultDates,
 Document tldDoc)
       throws ParserConfigurationException,
SAXException,
IOException,
XPathExpressionException

Extracts the components of an XML-parsed *.tld file.

Parameters:

summaryClass - The CSS class that marks elements to be included in summaries

tldPath - The path to the taglib, used for error messages only

defaultDates - The optional default dates for when no date-comments found

tldDoc - The document that has already been parsed

Throws:

ParserConfigurationException

SAXException

IOException

XPathExpressionException

Taglib

@Deprecated(forRemoval=true)
public Taglib(String summaryClass,
 String tldPath,
 Dates defaultDates,
 Document tldDoc,
 Map<String,String> apiLinks)
       throws ParserConfigurationException,
SAXException,
IOException,
XPathExpressionException

Deprecated, for removal: This API element is subject to removal in a future version.

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

Extracts the components of an XML-parsed *.tld file.

Parameters:

summaryClass - The CSS class that marks elements to be included in summaries

tldPath - The path to the taglib, used for error messages only

defaultDates - The optional default dates for when no date-comments found

tldDoc - The document that has already been parsed

Throws:

ParserConfigurationException

SAXException

IOException

XPathExpressionException

Method Details

getTldPath

public String getTldPath()

getDates

public Dates getDates()

getAllowRobots

public Boolean getAllowRobots()

getDescriptions

public List<String> getDescriptions()

getDisplayNames

public List<String> getDisplayNames()

getTlibVersion

public String getTlibVersion()

getShortName

public String getShortName()

getUri

public String getUri()

getTag

public Map<String,Tag> getTag()

getTags

public List<Tag> getTags()

getTagsEffectiveDates

public Dates getTagsEffectiveDates()

Gets the effective dates for the all tags.

Returns:

the effective dates or null when there are no tags

getFunction

public Map<String,Function> getFunction()

getFunctions

public List<Function> getFunctions()

getFunctionsEffectiveDates

public Dates getFunctionsEffectiveDates()

Gets the effective dates for the all functions.

Returns:

the effective dates or null when there are no functions

getTaglibEffectiveDates

public Dates getTaglibEffectiveDates()

Gets the effective dates for the taglib overall, including itself along with all tags and functions.