xdoclet.modules.wsee

Class WsdlSubTask

Implemented Interfaces:
Serializable

public class WsdlSubTask
extends xdoclet.XmlSubTask

Subtask that generates a service.wsdl service descriptor.
Version:
$Revision: 1.2 $
Authors:
Christoph G. Jung (christoph.jung@infor.de)
Jason Essington (jasone@greenrivercomputing.com)
ant.element
display-name = "service.wsdl" name = "wsdl" 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

static String
DEFAULT_WSDL_FILE_PATTERN

Fields inherited from class xdoclet.DocletSupport

currentClassTag, currentFieldTag, currentMethodTag

Constructor Summary

WsdlSubTask()
sets template

Method Summary

protected void
engineStarted()
notify start of task
void
execute()
run subtask
protected String
getGeneratedFileName(XClass clazz)
Returns class name for the generated file.
boolean
isPrefixWithPackageStructure()
Gets the PrefixWithPackageStructure attribute of the TemplateSubTask object
protected boolean
matchesGenerationRules(XClass clazz)
Describe what the method does
void
setPrefixWithPackageStructure(boolean prefixWithPackageStructure)
Indicates whether or not to prefix with package structure.
void
validateOptions()

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, copyAttributesFrom, engineFinished, engineStarted, execute, 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, startProcess, startProcessForAll, startProcessPerClass, validateOptions

Methods inherited from class xdoclet.SubTask

addConfigParam, copyAttributesFrom, execute, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, init, setDestDir, setMergeDir, setSubTaskName, validateOptions

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

Field Details

DEFAULT_WSDL_FILE_PATTERN

public static final String DEFAULT_WSDL_FILE_PATTERN

Constructor Details

WsdlSubTask

public WsdlSubTask()
sets template

Method Details

engineStarted

protected void engineStarted()
            throws xdoclet.XDocletException
notify start of task
Overrides:
engineStarted in interface xdoclet.TemplateSubTask
Throws:
xdoclet.XDocletException -

execute

public void execute()
            throws xdoclet.XDocletException
run subtask
Overrides:
execute in interface xdoclet.TemplateSubTask
Throws:
xdoclet.XDocletException -

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)
            throws xdoclet.XDocletException
Returns class name for the generated file. {0} substituted by wsee.port-component name.
Overrides:
getGeneratedFileName in interface xdoclet.TemplateSubTask
Parameters:
clazz - Description of Parameter
Returns:
The GeneratedClassName value
Throws:
xdoclet.XDocletException - Description of Exception

isPrefixWithPackageStructure

public boolean isPrefixWithPackageStructure()
Gets the PrefixWithPackageStructure attribute of the TemplateSubTask object
Overrides:
isPrefixWithPackageStructure in interface xdoclet.TemplateSubTask
Returns:
The PrefixWithPackageStructure value

matchesGenerationRules

protected boolean matchesGenerationRules(XClass clazz)
            throws xdoclet.XDocletException
Describe what the method does
Overrides:
matchesGenerationRules in interface xdoclet.TemplateSubTask
Parameters:
clazz - Describe what the parameter does
Returns:
Describe the return value
Throws:
xdoclet.XDocletException -

setPrefixWithPackageStructure

public void setPrefixWithPackageStructure(boolean prefixWithPackageStructure)
Indicates whether or not to prefix with package structure.
Overrides:
setPrefixWithPackageStructure in interface xdoclet.TemplateSubTask
Parameters:
prefixWithPackageStructure - The new PrefixWithPackageStructure value
ant.not-required
No,defaultis "true"

validateOptions

public void validateOptions()
            throws xdoclet.XDocletException
Overrides:
validateOptions in interface xdoclet.TemplateSubTask