xdoclet.modules.web
Class ServiceEndpointSubTask
java.lang.Object
xdoclet.DocletSupport
xdoclet.SubTask
xdoclet.TemplateSubTask
xdoclet.modules.web.ServiceEndpointSubTask
- Serializable
public class ServiceEndpointSubTask
extends xdoclet.TemplateSubTask
Generates service endpoint interfaces for JAXPRC beans.
- Christoph G. Jung (christoph.jung@infor.de)
- display-name = "Service-Endpoint Interface"
name = "service-endpoint"
parent = "xdoclet.modules.web.WebDocletTask"
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.
|
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 |
addConfigParam , copyAttributesFrom , execute , getConfigParams , getConfigParamsAsMap , getContext , getDestDir , getMergeDir , getSubTaskName , getXJavaDoc , init , setDestDir , setMergeDir , setSubTaskName , validateOptions |
getCurrentClass , getCurrentClassTag , getCurrentConstructor , getCurrentField , getCurrentFieldTag , getCurrentMethod , getCurrentMethodTag , getCurrentPackage , getCurrentTag , isDocletGenerated , popCurrentClass , pushCurrentClass , setCurrentClass , setCurrentClassTag , setCurrentConstructor , setCurrentField , setCurrentFieldTag , setCurrentMethod , setCurrentMethodTag , setCurrentPackage |
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.
ServiceEndpointSubTask
public ServiceEndpointSubTask()
Describe what the ServiceEndpointSubTask constructor does
engineStarted
protected void engineStarted()
throws xdoclet.XDocletException
Describe what the method does
- engineStarted in interface xdoclet.TemplateSubTask
xdoclet.XDocletException
-
getGeneratedFileName
protected String getGeneratedFileName(XClass clazz)
throws xdoclet.XDocletException
Gets the GeneratedFileName attribute of the ServiceEndpointInterfaceSubTask object
- getGeneratedFileName in interface xdoclet.TemplateSubTask
clazz
- Describe what the parameter does
- The GeneratedFileName value
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.
- The ServiceEndpointClassPattern value
matchesGenerationRules
protected boolean matchesGenerationRules(XClass clazz)
throws xdoclet.XDocletException
Describe what the method does
- matchesGenerationRules in interface xdoclet.TemplateSubTask
clazz
- Describe what the parameter does
- Describe the return value
xdoclet.XDocletException
-
setPattern
public void setPattern(String newPattern)
The pattern by which the interfaces are named. {0} designates the EJB name.
newPattern
- The new Pattern value
validateOptions
public void validateOptions()
throws xdoclet.XDocletException
Called to validate configuration parameters.
- validateOptions in interface xdoclet.TemplateSubTask
xdoclet.XDocletException
-