|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectxdoclet.DocletSupport
xdoclet.SubTask
xdoclet.TemplateSubTask
xdoclet.XmlSubTask
xdoclet.modules.web.WebXmlSubTask
public class WebXmlSubTask
Generates web.xml deployment descriptor.
Nested Class Summary | |
---|---|
static class |
WebXmlSubTask.ContextParam
The declaration of a web application's servlet context initialization parameter. |
static class |
WebXmlSubTask.ServletVersionTypes
Supported Servlet spec versions. |
static class |
WebXmlSubTask.TagLib
Describes a JSP tag library. |
static class |
WebXmlSubTask.WelcomeFile
The welcomefile element contains file name to use as a default welcome file, such as index.html. |
Nested classes/interfaces inherited from class xdoclet.TemplateSubTask |
---|
TemplateSubTask.ExtentTypes, TemplateSubTask.OfType |
Field Summary | |
---|---|
protected java.util.ArrayList |
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 java.lang.Integer |
sessionTimeout
|
protected java.lang.String |
smallIcon
|
protected java.util.ArrayList |
tagLibs
|
protected java.util.ArrayList |
welcomeFiles
|
Fields inherited from class xdoclet.DocletSupport |
---|
currentClassTag, currentFieldTag, currentMethodTag |
Constructor Summary | |
---|---|
WebXmlSubTask()
Describe what the WebXmlSubTask constructor does |
Method Summary | |
---|---|
void |
addConfiguredContextparam(WebXmlSubTask.ContextParam cp)
Defines a web application context parameter. |
void |
addConfiguredTaglib(WebXmlSubTask.TagLib taglib)
Declares a custom tag library for the web application's JSPs. |
void |
addConfiguredWelcomefile(WebXmlSubTask.WelcomeFile file)
Defines a welcome file for the web application. |
protected void |
engineStarted()
Describe what the method does |
void |
execute()
Describe what the method does |
java.util.ArrayList |
getContextParams()
Gets the ContextParams attribute of the WebXmlSubTask object |
java.lang.String |
getDescription()
Gets the Description attribute of the WebXmlSubTask object |
java.lang.String |
getDisplayname()
Gets the Displayname attribute of the WebXmlSubTask object |
boolean |
getDistributable()
Gets the Distributable attribute of the WebXmlSubTask object |
java.lang.String |
getLargeicon()
Gets the Largeicon attribute of the WebXmlSubTask object |
java.lang.String |
getServletspec()
Gets the Servletspec attribute of the WebXmlSubTask object |
java.lang.Integer |
getSessiontimeout()
Gets the Sessiontimeout attribute of the WebXmlSubTask object |
java.lang.String |
getSmallicon()
Gets the Smallicon attribute of the WebXmlSubTask object |
java.util.ArrayList |
getTagLibs()
Gets the TagLibs attribute of the WebXmlSubTask object |
java.util.ArrayList |
getWelcomeFiles()
Gets the WelcomeFiles attribute of the WebXmlSubTask object |
void |
setContextParams(java.util.ArrayList contextParams)
Sets the ContextParams attribute of the WebXmlSubTask object |
void |
setDescription(java.lang.String description)
Optional description of the web application. |
void |
setDisplayname(java.lang.String displayName)
Optional short name for the web application that is intended to be displayed by tools. |
void |
setDistributable(boolean distributable)
Optional boolean flag indicating whether this web application is programmed appropriately to be deployed into a distributed servlet container. |
void |
setLargeicon(java.lang.String largeIcon)
Optional relative path within the web application's war file of a large (32 x 32) icon image in either JPEG or GIF format. |
void |
setServletspec(WebXmlSubTask.ServletVersionTypes servletSpec)
The Servlet spec version to which the web application conforms. |
void |
setSessiontimeout(java.lang.Integer session_timeout)
The default session timeout interval for all sessions created in this web application. |
void |
setSmallicon(java.lang.String smallIcon)
Optional relative path within the web application's war file of a small (16 x 16) icon image in either JPEG or GIF format. |
void |
setTagLibs(java.util.ArrayList tagLibs)
Sets the TagLibs attribute of the WebXmlSubTask object |
void |
setWelcomeFiles(java.util.ArrayList welcomeFiles)
Sets the WelcomeFiles attribute of the WebXmlSubTask object |
Methods inherited from class xdoclet.XmlSubTask |
---|
copyAttributesFrom, engineFinished, getDtdURL, getPublicId, getSchema, getSchemaURL, getSystemId, getUseIds, getXmlencoding, isValidateXML, setDtdURL, setPublicId, setSchema, setSchemaURL, setSystemId, setUseIds, setValidateXML, setXmlencoding, startProcess |
Methods inherited from class xdoclet.SubTask |
---|
addConfigParam, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, setDestDir, setMergeDir, setSubTaskName |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.lang.String servletSpec
protected java.lang.String smallIcon
protected java.lang.String largeIcon
protected java.lang.String displayName
protected java.lang.String description
protected boolean distributable
protected java.util.ArrayList contextParams
protected java.lang.Integer sessionTimeout
protected java.util.ArrayList welcomeFiles
protected java.util.ArrayList tagLibs
Constructor Detail |
---|
public WebXmlSubTask()
Method Detail |
---|
public java.lang.String getServletspec()
public java.util.ArrayList getContextParams()
public java.lang.String getSmallicon()
public java.lang.String getLargeicon()
public java.lang.String getDisplayname()
public java.lang.String getDescription()
public boolean getDistributable()
public java.lang.Integer getSessiontimeout()
public java.util.ArrayList getWelcomeFiles()
public java.util.ArrayList getTagLibs()
public void setServletspec(WebXmlSubTask.ServletVersionTypes servletSpec)
servletSpec
- The new Servletspec valuepublic void setSmallicon(java.lang.String smallIcon)
smallIcon
- The new smallIcon valuepublic void setLargeicon(java.lang.String largeIcon)
largeIcon
- The new largeIcon valuepublic void setDisplayname(java.lang.String displayName)
displayName
- The new Displayname valuepublic void setDescription(java.lang.String description)
description
- The new Description valuepublic void setDistributable(boolean distributable)
distributable
- The new Distributable valuepublic void setSessiontimeout(java.lang.Integer session_timeout)
session_timeout
- The new Sessiontimeout valuepublic void setTagLibs(java.util.ArrayList tagLibs)
tagLibs
- The new TagLibs valuepublic void setWelcomeFiles(java.util.ArrayList welcomeFiles)
welcomeFiles
- The new WelcomeFiles valuepublic void setContextParams(java.util.ArrayList contextParams)
contextParams
- The new ContextParams valuepublic void addConfiguredContextparam(WebXmlSubTask.ContextParam cp)
cp
- Describe the method parameterpublic void addConfiguredWelcomefile(WebXmlSubTask.WelcomeFile file)
file
- Describe the method parameterpublic void addConfiguredTaglib(WebXmlSubTask.TagLib taglib)
taglib
- Describe the method parameterpublic void execute() throws XDocletException
execute
in class TemplateSubTask
XDocletException
protected void engineStarted() throws XDocletException
engineStarted
in class TemplateSubTask
XDocletException
|
http://xdoclet.sourceforge.net/ | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |