xdoclet.modules.wsee
Class WebServicesXmlSubTask

java.lang.Object
  xdoclet.DocletSupport
      xdoclet.SubTask
          xdoclet.TemplateSubTask
              xdoclet.XmlSubTask
                  xdoclet.modules.wsee.WebServicesXmlSubTask

All Implemented Interfaces:

java.io.Serializable

public class WebServicesXmlSubTask
extends XmlSubTask

SubTask that generates the web-services.xml deployment descriptor.

Version:

$Revision: 1.3 $

Author:

Christoph G. Jung (christoph.jung@infor.de)

See Also:

Serialized Form

ant.element

display-name = "webservices.xml" name = "deploymentdescriptor" parent = "xdoclet.modules.wsee.WseeDocletTask"

created

23.12.03

Nested Class Summary

Nested classes/interfaces inherited from class xdoclet.TemplateSubTask

TemplateSubTask.ExtentTypes, TemplateSubTask.OfType

Field Summary

protected java.lang.String	description
protected java.lang.String	displayName
protected java.lang.String	largeIcon
protected java.lang.String	name
protected java.lang.String	smallIcon state

Fields inherited from class xdoclet.DocletSupport

currentClassTag, currentFieldTag, currentMethodTag

Constructor Summary

WebServicesXmlSubTask()
initializes default output location and template names

Method Summary

protected void	engineStarted() feedback upon engine start
void	execute() runs the subtask
java.lang.String	getDescription() Gets the Description attribute of the WebXmlSubTask object
java.lang.String	getDisplayName()
java.lang.String	getLargeIcon()
java.lang.String	getName()
java.lang.String	getSmallIcon()
void	setDescription(java.lang.String description) Sets the Description attribute of the WebXmlSubTask object
void	setDisplayName(java.lang.String string) set display name
void	setLargeIcon(java.lang.String string) set large icon location
void	setName(java.lang.String string) set descriptor name
void	setSmallIcon(java.lang.String string) set small icon location

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.TemplateSubTask

addOfType, addOfType, addPackageSubstitution, generateForClass, getAcceptAbstractClasses, getAcceptInterfaces, getDestinationFile, getEngine, getExtent, getGeneratedFileName, getGenerationManager, getHavingClassTag, getOfType, getPackageSubstitutions, getSubTaskClassName, getTemplateURL, init, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, matchesGenerationRules, processInnerClasses, setAcceptAbstractClasses, setAcceptInterfaces, setDestinationFile, setEngine, setExtent, setExtentValue, setGenerationManager, setHavingClassTag, setOfType, setPackageSubstitutionInheritanceSupported, setPackageSubstitutions, setPrefixWithPackageStructure, setSubTaskClassName, setTemplateFile, setTemplateURL, startEngine, startProcessForAll, startProcessPerClass, validateOptions

Methods inherited from class xdoclet.SubTask

addConfigParam, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, setDestDir, setMergeDir, setSubTaskName

Methods inherited from class xdoclet.DocletSupport

getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage

Methods inherited from class java.lang.Object

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

Field Detail

smallIcon

protected java.lang.String smallIcon

state

largeIcon

protected java.lang.String largeIcon

displayName

protected java.lang.String displayName

description

protected java.lang.String description

name

protected java.lang.String name

Constructor Detail

WebServicesXmlSubTask

public WebServicesXmlSubTask()

initializes default output location and template names

Method Detail

getDescription

public java.lang.String getDescription()

Gets the Description attribute of the WebXmlSubTask object

Returns:

The Description value

getDisplayName

public java.lang.String getDisplayName()

Returns:

the display name of the webservice descriptor

getLargeIcon

public java.lang.String getLargeIcon()

Returns:

large icon location

getName

public java.lang.String getName()

Returns:

id of the descriptor

getSmallIcon

public java.lang.String getSmallIcon()

Returns:

small icon location

setDescription

public void setDescription(java.lang.String description)

Sets the Description attribute of the WebXmlSubTask object

Parameters:

description - The new Description value

setDisplayName

public void setDisplayName(java.lang.String string)

set display name

Parameters:

string - name

setLargeIcon

public void setLargeIcon(java.lang.String string)

set large icon location

Parameters:

string - location

setName

public void setName(java.lang.String string)

set descriptor name

Parameters:

string - name

setSmallIcon

public void setSmallIcon(java.lang.String string)

set small icon location

Parameters:

string - location

execute

public void execute()
             throws XDocletException

runs the subtask

Overrides:

execute in class TemplateSubTask

Throws:

XDocletException

engineStarted

protected void engineStarted()
                      throws XDocletException

feedback upon engine start

Overrides:

engineStarted in class TemplateSubTask

Throws:

XDocletException