public interface DescriptionElement extends DocumentableElement
Modifier and Type | Method and Description |
---|---|
BindingElement |
addBindingElement()
Create a BindingElement with this DescriptionElement as its parent and
return a reference to it.
|
ImportElement |
addImportElement()
Create an ImportElement with this DescriptionElement as its parent and
return a reference to it.
|
IncludeElement |
addIncludeElement()
Create an IncludeElement with this DescriptionElement as its parent and
return a reference to it.
|
InterfaceElement |
addInterfaceElement()
Create an InterfaceElement with this DescriptionElement as its parent and
return a reference to it.
|
ServiceElement |
addServiceElement()
Create a ServiceElement with this DescriptionElement as its parent and
return a reference to it.
|
TypesElement |
addTypesElement()
Create a TypesElement with this DescriptionElement as its parent and
return a reference to it.
|
BindingElement[] |
getBindingElements()
Return the set of BindingElements within this DescriptionElement.
|
URI |
getDocumentBaseURI()
Return the document base URI that was used to locate the <description> element that
this DescriptionElement corresponds to.
|
ImportElement[] |
getImportElements()
Return the set of ImportElements within this DescriptionElement.
|
IncludeElement[] |
getIncludeElements()
Return the set of IncludeElements within this DescriptionElement.
|
InterfaceElement[] |
getInterfaceElements()
Return the set of InterfaceElements within this DescriptionElement.
|
ServiceElement[] |
getServiceElements()
Return the set of ServiceElements within this DescriptionElement.
|
URI |
getTargetNamespace()
Return the target namespace URI.
|
TypesElement |
getTypesElement()
Return the TypesElement within this DescriptionElement.
|
void |
setDocumentBaseURI(URI documentBaseURI)
Set the document base URI to the specified URI.
|
void |
setTargetNamespace(URI namespaceURI)
Set the target namespace to the specified URI.
|
Description |
toComponent()
Return the Description component derived from this DescriptionElement.
|
addDocumentationElement, getDocumentationElements
addNamespace, getDeclaredNamespaces, getInScopeNamespaces, getNamespacePrefix, getNamespaceURI, removeNamespace
getExtensionAttribute, getExtensionAttributes, getExtensionAttributesForNamespace, hasExtensionAttributesForNamespace, setExtensionAttribute
addExtensionElement, getExtensionElements, getExtensionElementsOfType, hasExtensionElementsForNamespace, removeExtensionElement
void setDocumentBaseURI(URI documentBaseURI)
documentBaseURI
- the base URI of the WSDLURI getDocumentBaseURI()
void setTargetNamespace(URI namespaceURI)
targetNamespace
attribute of the <description>
element.namespaceURI
- the target namespace URIURI getTargetNamespace()
targetNamespace
attribute of the <description>
element.ImportElement addImportElement()
IncludeElement addIncludeElement()
InterfaceElement addInterfaceElement()
BindingElement addBindingElement()
ServiceElement addServiceElement()
ImportElement[] getImportElements()
IncludeElement[] getIncludeElements()
TypesElement getTypesElement()
TypesElement addTypesElement() throws WSDLException
WSDLException
InterfaceElement[] getInterfaceElements()
BindingElement[] getBindingElements()
ServiceElement[] getServiceElements()
Description toComponent()
The Description component is unlike other WSDL components which map neatly to a single WSDL element. Description represents a 'flattened' view of the entire WSDL infoset tree, including the WSDL components from any imported or included WSDL documents, so it could contain the content of multiple <description> elements.
If this DescriptionElement imports or includes other DescriptionElements (that is, if it is the root of a composite WSDL document), the behaviour of this method is equivalent to traversing the WSDL tree recursively and aggregating the WSDL content of each DescriptionElement into a single Description component.
This equates to retrieving the root <description> element and traversing any <wsdl:import> or <wsdl:include> elements to retrieve WSDL content of any nested <description> elements.
The toComponent()
method is only defined for DescriptionElement, not for
other WSDL Element interfaces. This is because the WSDL 2.0 Component model is a nested
hierarchy with a single Description component at the top. To access WSDL components,
we must start at the Description and traverse the component model from there.
Copyright © 2005–2019 Apache Software Foundation. All rights reserved.