xdoclet.modules.web

Class JspTaglibSubTask

public class JspTaglibSubTask extends XmlSubTask

Generates taglib.tld deployment descriptor for JSP taglibs.

Version: $Revision: 1.15 $

Author: Ara Abrahamian (ara_e@email.com)

UNKNOWN: July 12, 2001 display-name = "JSP Taglib" name = "jsptaglib" parent = "xdoclet.modules.web.WebDocletTask" file = "taglib-settings.xml" relates-to = "taglib.tld" description = "Unparsed XML entity containing * (tlib-version, jsp-version, short-name, uri?, display-name?, small-icon?, large-icon?, description?) elements." file = "taglib-validator.xml" relates-to = "taglib.tld" description = "XML document containing the * validator element, used to include a validator which isn't processed by XDoclet." file = "taglib-listener.xml" relates-to = "taglib.tld" description = "Unparsed XML entity containing * additional listener elements, for including listeners not processed by XDoclet." file = "taglib-tag.xml" relates-to = "taglib.tld" description = "Unparsed XML entity containing * additional tag elements, for including tags not processed by XDoclet."

Nested Class Summary
static classJspTaglibSubTask.JspVersionTypes
Supported JSP spec versions.
Field Summary
protected Stringdescription
protected Stringdisplayname
protected Stringfilename
protected Stringjspversion
protected Stringlargeicon
protected Stringshortname
protected Stringsmallicon
protected Stringtaglibversion
protected Stringuri
Constructor Summary
JspTaglibSubTask()
Describe what the JspTaglibSubTask constructor does
Method Summary
protected voidengineStarted()
Describe what the method does
voidexecute()
Describe what the method does
StringgetDescription()
Gets the Description attribute of the JspTaglibSubTask object
StringgetDisplayname()
Gets the Displayname attribute of the JspTaglibSubTask object
StringgetFilename()
Gets the Filename attribute of the JspTaglibSubTask object
StringgetJspversion()
Gets the Jspversion attribute of the JspTaglibSubTask object
StringgetLargeicon()
Gets the Largeicon attribute of the JspTaglibSubTask object
StringgetShortname()
Gets the Shortname attribute of the JspTaglibSubTask object
StringgetSmallicon()
Gets the Smallicon attribute of the JspTaglibSubTask object
StringgetTaglibversion()
Gets the Taglibversion attribute of the JspTaglibSubTask object
StringgetUri()
Gets the Uri attribute of the JspTaglibSubTask object
voidsetDescription(String new_description)
A simple string describing the use of this tag library, Should be user discernable.
voidsetDisplayname(String new_display_name)
A short name that is intended to be displayed by tools.
voidsetFilename(String new_filename)
Specifies the filename of the generated tag library descriptor.
voidsetJspversion(JspTaglibSubTask.JspVersionTypes jspversion)
The JSP spec version to which the tag library conforms.
voidsetLargeicon(String new_icon)
Optional large-icon that can be used by tools.
voidsetShortname(String shortname)
A simple default short name that could be used by a JSP authoring tool to create names with a mnemonic value.
voidsetSmallicon(String new_icon)
Optional small-icon that can be used by tools.
voidsetTaglibversion(String taglibversion)
The tag library implementation version.
voidsetUri(String uri)
A URI uniquely identifying this tag library.
voidvalidateOptions()
Called to validate configuration parameters.

Field Detail

description

protected String description

displayname

protected String displayname

filename

protected String filename

jspversion

protected String jspversion

largeicon

protected String largeicon

shortname

protected String shortname

smallicon

protected String smallicon

taglibversion

protected String taglibversion

uri

protected String uri

Constructor Detail

JspTaglibSubTask

public JspTaglibSubTask()
Describe what the JspTaglibSubTask constructor does

Method Detail

engineStarted

protected void engineStarted()
Describe what the method does

Throws: XDocletException

execute

public void execute()
Describe what the method does

Throws: XDocletException

getDescription

public String getDescription()
Gets the Description attribute of the JspTaglibSubTask object

Returns: The Description value

getDisplayname

public String getDisplayname()
Gets the Displayname attribute of the JspTaglibSubTask object

Returns: The Displayname value

getFilename

public String getFilename()
Gets the Filename attribute of the JspTaglibSubTask object

Returns: The Filename value

getJspversion

public String getJspversion()
Gets the Jspversion attribute of the JspTaglibSubTask object

Returns: The Jspversion value

getLargeicon

public String getLargeicon()
Gets the Largeicon attribute of the JspTaglibSubTask object

Returns: The Largeicon value

getShortname

public String getShortname()
Gets the Shortname attribute of the JspTaglibSubTask object

Returns: The Shortname value

getSmallicon

public String getSmallicon()
Gets the Smallicon attribute of the JspTaglibSubTask object

Returns: The Smallicon value

getTaglibversion

public String getTaglibversion()
Gets the Taglibversion attribute of the JspTaglibSubTask object

Returns: The Taglibversion value

getUri

public String getUri()
Gets the Uri attribute of the JspTaglibSubTask object

Returns: The Uri value

setDescription

public void setDescription(String new_description)
A simple string describing the use of this tag library, Should be user discernable.

Parameters: new_description The new Description value

setDisplayname

public void setDisplayname(String new_display_name)
A short name that is intended to be displayed by tools.

Parameters: new_display_name The new Displayname value

setFilename

public void setFilename(String new_filename)
Specifies the filename of the generated tag library descriptor.

Parameters: new_filename The new Filename value

setJspversion

public void setJspversion(JspTaglibSubTask.JspVersionTypes jspversion)
The JSP spec version to which the tag library conforms.

Parameters: jspversion The new Jspversion value

setLargeicon

public void setLargeicon(String new_icon)
Optional large-icon that can be used by tools.

Parameters: new_icon The new Largeicon value

setShortname

public void setShortname(String shortname)
A simple default short name that could be used by a JSP authoring tool to create names with a mnemonic value. For example, it may be used as the prefered prefix value in taglib directives.

Parameters: shortname The new Shortname value

setSmallicon

public void setSmallicon(String new_icon)
Optional small-icon that can be used by tools.

Parameters: new_icon The new Smallicon value

setTaglibversion

public void setTaglibversion(String taglibversion)
The tag library implementation version.

Parameters: taglibversion The new Taglibversion value

setUri

public void setUri(String uri)
A URI uniquely identifying this tag library.

Parameters: uri The new Uri value

validateOptions

public void validateOptions()
Called to validate configuration parameters.

Throws: XDocletException