xdoclet.web
Class WebXmlSubTask

java.lang.Object
  |
  +--xdoclet.DocletSupport
        |
        +--xdoclet.SubTask
              |
              +--xdoclet.TemplateSubTask
                    |
                    +--xdoclet.XmlSubTask
                          |
                          +--xdoclet.web.WebXmlSubTask

All Implemented Interfaces:

java.io.Serializable

public class WebXmlSubTask

extends XmlSubTask

Generates web.xml deployment descriptor.

Version:

$Revision: 1.15 $

Author:

Ara Abrahamian (ara_e@email.com)

See Also:

Serialized Form

Inner Class Summary

static class	WebXmlSubTask.ContextParam
static class	WebXmlSubTask.ServletVersionTypes
static class	WebXmlSubTask.TagLib
static class	WebXmlSubTask.WelcomeFile

Inner classes inherited from class xdoclet.TemplateSubTask

TemplateSubTask.ExtentTypes

Field Summary

protected java.util.Vector	contextParams
protected java.lang.String	description
protected java.lang.String	displayname
protected boolean	distributable
protected java.lang.String	largeicon
protected java.lang.String	servletspec
protected int	sessiontimeout
protected java.lang.String	smallicon
static java.lang.String	SUBTASK_NAME
protected java.util.Vector	tagLibs
protected java.util.Vector	welcomeFiles

Fields inherited from class xdoclet.XmlSubTask

useIds

Fields inherited from class xdoclet.DocletSupport

currentTag

Constructor Summary

WebXmlSubTask()

Method Summary

void	addContextparam(WebXmlSubTask.ContextParam cp)
void	addTaglib(WebXmlSubTask.TagLib taglib)
void	addWelcomefile(WebXmlSubTask.WelcomeFile file)
protected void	engineStarted()
void	execute() Called to start execution of the sub-task.
java.util.Vector	getContextParams()
java.lang.String	getDescription()
java.lang.String	getDisplayname()
boolean	getDistributable()
java.lang.String	getLargeicon()
java.lang.String	getServletspec()
int	getSessiontimeout()
java.lang.String	getSmallicon()
java.lang.String	getSubTaskName()
java.util.Vector	getTagLibs()
java.util.Vector	getWelcomeFiles()
void	setContextParams(java.util.Vector contextParams)
void	setDescription(java.lang.String new_description)
void	setDisplayname(java.lang.String new_display_name)
void	setDistributable(boolean distributable)
void	setLargeicon(java.lang.String new_icon)
void	setServletspec(WebXmlSubTask.ServletVersionTypes new_servletspec)
void	setSessiontimeout(int session_timeout)
void	setSmallicon(java.lang.String new_icon)
void	setTagLibs(java.util.Vector tagLibs)
void	setWelcomeFiles(java.util.Vector welcomeFiles)

Methods inherited from class xdoclet.XmlSubTask

copyAttributesFrom, engineFinished, getDtdFileName, getPublicId, getSchema, getSystemId, getUseIds, getXmlencoding, isValidateXML, setDtdFileName, setPublicId, setSchema, setSystemId, setUseIds, setValidateXML, setXmlencoding, startProcess

Methods inherited from class xdoclet.TemplateSubTask

addPackageSubstitution, beanFile, generateForClass, getDestinationFile, getEngine, getExtent, getGeneratedFileName, getHavingClassTag, getOfType, getPackageSubstitutions, getParser, getSubTaskClassName, getTemplateURL, init, isGuessGenerationNeeded, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, matchesGenerationRules, setDestinationFile, setEngine, setExtent, setExtentValue, setGuessGenerationNeeded, setHavingClassTag, setOfType, setPackageSubstitutionInheritanceSupported, setPackageSubstitutions, setParser, setPrefixWithPackageStructure, setSubTaskClassName, setTemplateFile, setTemplateURL, startEngine, validateOptions

Methods inherited from class xdoclet.SubTask

addConfigParam, getConfigParams, getContext, getDestDir, getMergeDir, setDestDir, setMergeDir, setSubTaskName

Methods inherited from class xdoclet.DocletSupport

getCurrentClass, getCurrentConstructor, getCurrentField, getCurrentMethod, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentConstructor, setCurrentField, setCurrentMethod, setCurrentPackage, setCurrentTag

Methods inherited from class java.lang.Object

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

Field Detail

SUBTASK_NAME

public static final java.lang.String SUBTASK_NAME

servletspec

protected java.lang.String servletspec

smallicon

protected java.lang.String smallicon

largeicon

protected java.lang.String largeicon

displayname

protected java.lang.String displayname

description

protected java.lang.String description

distributable

protected boolean distributable

contextParams

protected java.util.Vector contextParams

sessiontimeout

protected int sessiontimeout

welcomeFiles

protected java.util.Vector welcomeFiles

tagLibs

protected java.util.Vector tagLibs

Constructor Detail

WebXmlSubTask

public WebXmlSubTask()

Method Detail

getSubTaskName

public java.lang.String getSubTaskName()

Overrides:

getSubTaskName in class TemplateSubTask

getServletspec

public java.lang.String getServletspec()

getContextParams

public java.util.Vector getContextParams()

getSmallicon

public java.lang.String getSmallicon()

getLargeicon

public java.lang.String getLargeicon()

getDisplayname

public java.lang.String getDisplayname()

getDescription

public java.lang.String getDescription()

getDistributable

public boolean getDistributable()

getSessiontimeout

public int getSessiontimeout()

getWelcomeFiles

public java.util.Vector getWelcomeFiles()

getTagLibs

public java.util.Vector getTagLibs()

setServletspec

public void setServletspec(WebXmlSubTask.ServletVersionTypes new_servletspec)

setSmallicon

public void setSmallicon(java.lang.String new_icon)

setLargeicon

public void setLargeicon(java.lang.String new_icon)

setDisplayname

public void setDisplayname(java.lang.String new_display_name)

setDescription

public void setDescription(java.lang.String new_description)

setDistributable

public void setDistributable(boolean distributable)

setSessiontimeout

public void setSessiontimeout(int session_timeout)

setTagLibs

public void setTagLibs(java.util.Vector tagLibs)

setWelcomeFiles

public void setWelcomeFiles(java.util.Vector welcomeFiles)

setContextParams

public void setContextParams(java.util.Vector contextParams)

addContextparam

public void addContextparam(WebXmlSubTask.ContextParam cp)

addWelcomefile

public void addWelcomefile(WebXmlSubTask.WelcomeFile file)

addTaglib

public void addTaglib(WebXmlSubTask.TagLib taglib)

execute

public void execute()
             throws XDocletException

Description copied from class: SubTask

Called to start execution of the sub-task.

Overrides:

execute in class TemplateSubTask

Following copied from class: xdoclet.SubTask

Throws:

XDocletException - Description of Exception

engineStarted

protected void engineStarted()
                      throws XDocletException

Overrides:

engineStarted in class TemplateSubTask