xdoclet.modules.web

Class ServiceEndpointSubTask

Implemented Interfaces:
Serializable

public class ServiceEndpointSubTask
extends xdoclet.TemplateSubTask

Generates service endpoint interfaces for JAXPRC beans.
Version:
$Revision: 1.3 $
Author:
Christoph G. Jung (christoph.jung@infor.de)
ant.element
display-name = "Service-Endpoint Interface" name = "service-endpoint" parent = "xdoclet.modules.web.WebDocletTask"
created
22.12.03

Nested Class Summary

Nested classes/interfaces inherited from class xdoclet.TemplateSubTask

TemplateSubTask.ExtentTypes, TemplateSubTask.OfType

Field Summary

static String
DEFAULT_SERVICE_ENDPOINT_CLASS_PATTERN
protected static String
DEFAULT_TEMPLATE_FILE
static String
SERVICE_ENDPOINT
static String
WEB_SERVLET
protected String
serviceEndpointClassPattern
A configuration parameter for specifying the service-endpoint interface name pattern.

Fields inherited from class xdoclet.DocletSupport

currentClassTag, currentFieldTag, currentMethodTag

Constructor Summary

ServiceEndpointSubTask()
Describe what the ServiceEndpointSubTask constructor does

Method Summary

protected void
engineStarted()
Describe what the method does
protected String
getGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the ServiceEndpointInterfaceSubTask object
String
getServiceEndpointClassPattern()
Returns the configuration parameter for specifying the service-endpoint interface name pattern.
protected boolean
matchesGenerationRules(XClass clazz)
Describe what the method does
void
setPattern(String newPattern)
The pattern by which the interfaces are named.
void
validateOptions()
Called to validate configuration parameters.

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_SERVICE_ENDPOINT_CLASS_PATTERN

public static final String DEFAULT_SERVICE_ENDPOINT_CLASS_PATTERN

DEFAULT_TEMPLATE_FILE

protected static final String DEFAULT_TEMPLATE_FILE

SERVICE_ENDPOINT

public static final String SERVICE_ENDPOINT

WEB_SERVLET

public static final String WEB_SERVLET

serviceEndpointClassPattern

protected String serviceEndpointClassPattern
A configuration parameter for specifying the service-endpoint interface name pattern. By default the value is used for deciding the service-endpoint interface name. {0} in the value mean current class's symbolic name which for an EJBean is the EJB name.

Constructor Details

ServiceEndpointSubTask

public ServiceEndpointSubTask()
Describe what the ServiceEndpointSubTask constructor does

Method Details

engineStarted

protected void engineStarted()
            throws xdoclet.XDocletException
Describe what the method does
Overrides:
engineStarted in interface xdoclet.TemplateSubTask
Throws:
xdoclet.XDocletException -

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)
            throws xdoclet.XDocletException
Gets the GeneratedFileName attribute of the ServiceEndpointInterfaceSubTask object
Overrides:
getGeneratedFileName in interface xdoclet.TemplateSubTask
Parameters:
clazz - Describe what the parameter does
Returns:
The GeneratedFileName value
Throws:
xdoclet.XDocletException -

getServiceEndpointClassPattern

public String getServiceEndpointClassPattern()
Returns the configuration parameter for specifying the service-endpoint interface name pattern. By default the value is used for deciding the service-endpoint interface name. {0} in the value mean current class's symbolic name which for an EJBean is the EJB name. If nothing explicitly specified by user then "{0}" is used by default.
Returns:
The ServiceEndpointClassPattern value
See Also:
ServiceEndpointSubTask

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 -

setPattern

public void setPattern(String newPattern)
The pattern by which the interfaces are named. {0} designates the EJB name.
Parameters:
newPattern - The new Pattern value
ant.not-required
No,defaultsto {0}

validateOptions

public void validateOptions()
            throws xdoclet.XDocletException
Called to validate configuration parameters.
Overrides:
validateOptions in interface xdoclet.TemplateSubTask
Throws:
xdoclet.XDocletException -