Module com.semanticcms.tagreference

Package com.semanticcms.tagreference

Class TagReferenceInitializer

java.lang.Object

com.semanticcms.tagreference.TagReferenceInitializer

All Implemented Interfaces:

ServletContainerInitializer

public abstract class TagReferenceInitializer
extends Object
implements ServletContainerInitializer

Initializes a tag reference during application start-up. The following URL patterns are registered:

1. /path/taglib.tld The taglib file itself available for download (handled by default servlet)
2. /path/taglib.tld/ The documentation for the taglib overall
3. /path/taglib.tld/tags The list of tags only
4. /path/taglib.tld/tag-tagName The detailed per-tag documentation
5. /path/taglib.tld/functions The list of functions only
6. /path/taglib.tld/function-functionName The detailed per-function documentation

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NOFOLLOW_PREFIX
static final String	SUMMARY_CLASS	The css class that marks an element as being a summary.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TagReferenceInitializer(String title, String shortTitle, String tldBook, String tldPath, boolean requireLinks, String javadocLinkJavaSE, String javadocLinkJavaEE, String... additionalApiLinks)	Parses the TLD file.
protected	TagReferenceInitializer(String title, String shortTitle, String tldBook, String tldPath, boolean requireLinks, String javadocLinkJavaSE, String javadocLinkJavaEE, Map<String,String> additionalApiLinks)	Parses the TLD file.
protected	TagReferenceInitializer(String title, String shortTitle, String tldBook, String tldPath, String javadocLinkJavaSE, String javadocLinkJavaEE, Map<String,String> additionalApiLinks)	Deprecated, for removal: This API element is subject to removal in a future version. Please provide requireLinks to either TagReferenceInitializer(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, java.lang.String, java.lang.String, java.util.Map) or TagReferenceInitializer(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, java.lang.String, java.lang.String, java.lang.String...)

Method Summary

Modifier and Type	Method	Description
void	onStartup(Set<Class<?>> set, ServletContext servletContext)	The *.tld file is parsed entirely on start-up to maximize runtime performance.

Methods inherited from class java.lang.Object

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

Field Details

SUMMARY_CLASS

public static final String SUMMARY_CLASS

The css class that marks an element as being a summary.

See Also:

• Constant Field Values

NOFOLLOW_PREFIX

public static final String NOFOLLOW_PREFIX

See Also:

• Constant Field Values

Constructor Details

TagReferenceInitializer

protected TagReferenceInitializer(String title,
 String shortTitle,
 String tldBook,
 String tldPath,
 boolean requireLinks,
 String javadocLinkJavaSE,
 String javadocLinkJavaEE,
 Map<String,String> additionalApiLinks)

Parses the TLD file.

Parameters:

javadocLinkJavaSE - The Java SE API URL. This matches values used in Maven build property ${javadoc.link.javase}.

javadocLinkJavaEE - The Java EE API URL. This matches values used in Maven build property ${javadoc.link.javaee}.

additionalApiLinks - Additional API links. When there are duplicate packages, the first match wins. The API links may be prefixed with NOFOLLOW_PREFIX to have rel="nofollow" in the generated links.

TagReferenceInitializer

protected TagReferenceInitializer(String title,
 String shortTitle,
 String tldBook,
 String tldPath,
 boolean requireLinks,
 String javadocLinkJavaSE,
 String javadocLinkJavaEE,
 String... additionalApiLinks)

Parses the TLD file.

Parameters:

javadocLinkJavaSE - The Java SE API URL. This matches values used in Maven build property ${javadoc.link.javase}.

javadocLinkJavaEE - The Java EE API URL. This matches values used in Maven build property ${javadoc.link.javaee}.

additionalApiLinks - Additional API links, must be in even pairs (package, apiLinks), ... When there are duplicate packages, the first match wins.)

TagReferenceInitializer

@Deprecated(forRemoval=true)
protected TagReferenceInitializer(String title,
 String shortTitle,
 String tldBook,
 String tldPath,
 String javadocLinkJavaSE,
 String javadocLinkJavaEE,
 Map<String,String> additionalApiLinks)

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

Please provide requireLinks to either TagReferenceInitializer(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, java.lang.String, java.lang.String, java.util.Map) or TagReferenceInitializer(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, java.lang.String, java.lang.String, java.lang.String...)

Parses the TLD file.

Calls TagReferenceInitializer(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, java.lang.String, java.lang.String, java.util.Map), with requireLinks = false for backward compatibility.

Method Details

onStartup

public void onStartup(Set<Class<?>> set,
 ServletContext servletContext)
               throws ServletException

The *.tld file is parsed entirely on start-up to maximize runtime performance.

Specified by:

onStartup in interface ServletContainerInitializer

Throws:

ServletException