com.sun.faces.generate

Class JspTLDGenerator

java.lang.Object

com.sun.faces.generate.JspTLDGenerator

All Implemented Interfaces:

Generator

Direct Known Subclasses:

JspTLD12Generator, JspTLD21Generator, JspToFaceletsTLD21Generator

public abstract class JspTLDGenerator
extends Object
implements Generator

Base class for JSP TLD generation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	JspTLDGenerator.XMLWriter A simple class to handle the writing of XML documents.

Field Summary

Fields

Modifier and Type	Field and Description
protected FacesConfigBean	configBean
protected PropertyManager	propManager
protected JspTLDGenerator.XMLWriter	writer

Constructor Summary

Constructors

Constructor and Description
JspTLDGenerator(PropertyManager propManager)

Method Summary

Modifier and Type	Method and Description
protected boolean	attributeShouldBeExcluded(RendererBean renderer, String attribute)
protected void	endDocument()
void	generate(FacesConfigBean configBean) Perform whatever generation tasks are necessary using the provided FacesConfigBean as the model.
protected String	getBodyContent(String tagName) Return the tag body content information (if any) for a given tag.
protected String	getRtexprvalue(String tagName, String attributeName) Return the "rtexprvalue" element value for the tag attribute.
protected void	initWriter()
protected String	loadOptionalTags() Load any additional tag definitions from the specified file.
protected String	makeTldTagName(String componentFamily, String rendererType) Build the tag name from componentFamily and rendererType.
protected void	writeDocument()
protected void	writeProlog()
protected abstract void	writeTags()
protected abstract void	writeTldDescription()
protected void	writeValidators()

Methods inherited from class java.lang.Object

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

Field Detail

writer

protected JspTLDGenerator.XMLWriter writer

configBean

protected FacesConfigBean configBean

propManager

protected PropertyManager propManager

Constructor Detail

JspTLDGenerator

public JspTLDGenerator(PropertyManager propManager)

Method Detail

generate

public void generate(FacesConfigBean configBean)

Description copied from interface: Generator

Perform whatever generation tasks are necessary using the provided FacesConfigBean as the model.

Specified by:

generate in interface Generator

Parameters:

configBean - model data

writeDocument

protected void writeDocument()
                      throws IOException

Throws:

IOException

writeProlog

protected void writeProlog()
                    throws IOException

Throws:

IOException

writeTldDescription

protected abstract void writeTldDescription()
                                     throws IOException

Throws:

IOException

writeTags

protected abstract void writeTags()
                           throws IOException

Throws:

IOException

endDocument

protected void endDocument()
                    throws IOException

Throws:

IOException

writeValidators

protected void writeValidators()
                        throws IOException

Throws:

IOException

initWriter

protected void initWriter()
                   throws IOException

Throws:

IOException

makeTldTagName

protected String makeTldTagName(String componentFamily,
                                String rendererType)

Build the tag name from componentFamily and rendererType. The name will be "camel case".

Parameters:

componentFamily - the component family

rendererType - the renderer type

attributeShouldBeExcluded

protected boolean attributeShouldBeExcluded(RendererBean renderer,
                                            String attribute)

Returns:

true if this attribute is in the set of attributes to be excluded by this renderer.

getBodyContent

protected String getBodyContent(String tagName)

Return the tag body content information (if any) for a given tag.

getRtexprvalue

protected String getRtexprvalue(String tagName,
                                String attributeName)

Return the "rtexprvalue" element value for the tag attribute.

loadOptionalTags

protected String loadOptionalTags()
                           throws IOException

Load any additional tag definitions from the specified file. This file might include tags such as "column" which have no renderer, but need to be generated into the TLD file.

Throws:

IOException