org.mule.runtime.extension.xml.dsl.api

Class DslElementSyntax

java.lang.Object

org.mule.runtime.extension.xml.dsl.api.DslElementSyntax

public class DslElementSyntax
extends Object

Provides a declaration of how a Component is represented in XML, containing all the required information for the XML element creation and parsing.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description

DslElementSyntax(String attributeName, String elementName, String abstractElementName, String elementNameSpace, String nameSpaceUri, boolean isWrapped, boolean supportsChildDeclaration, boolean supportsTopLevelDeclaration, boolean requiresConfig, Map<org.mule.metadata.api.model.MetadataType,DslElementSyntax> genericsDsl, Map<String,DslElementSyntax> childsByName, List<QName> substitutionGroups) Creates a new instance of DslElementSyntax

Method Summary

Modifier and Type	Method and Description
String	getAbstractElementName()
String	getAttributeName()
Optional<DslElementSyntax>	getChild(String name)
String	getElementName()
Optional<DslElementSyntax>	getGeneric(org.mule.metadata.api.model.MetadataType type)
String	getNamespace()
String	getNamespaceUri()
List<QName>	getSubstitutionGroups()
boolean	isWrapped()
boolean	requiresConfig()
boolean	supportsChildDeclaration()
boolean	supportsTopLevelDeclaration()

Methods inherited from class java.lang.Object

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

Constructor Detail

DslElementSyntax

public DslElementSyntax(String attributeName,
                        String elementName,
                        String abstractElementName,
                        String elementNameSpace,
                        String nameSpaceUri,
                        boolean isWrapped,
                        boolean supportsChildDeclaration,
                        boolean supportsTopLevelDeclaration,
                        boolean requiresConfig,
                        Map<org.mule.metadata.api.model.MetadataType,DslElementSyntax> genericsDsl,
                        Map<String,DslElementSyntax> childsByName,
                        List<QName> substitutionGroups)

Creates a new instance of DslElementSyntax

Parameters:

attributeName - the name of the attribute in the parent element that references this element

elementName - the name of this xml element

abstractElementName - the name of the abstract xml element

elementNameSpace - the namespace of this xml element

isWrapped - false if the element implements the Component's type as an xml extension, or true if the element is a wrapper of a ref to the Component's type

supportsChildDeclaration - true if this element supports to be declared as a child element of its parent

requiresConfig - whether the element requires a parameter pointing to the config

genericsDsl - the DslElementSyntax of this element's type generics, if any is present, that complete the element description of container elements of generic types, like Collections or Maps for which the Dsl declaration is modified depending on the contained type.

childsByName - the DslElementSyntax of this element's named childs. For complex types with fields that are mapped as child elements of this element, the Dsl varies depending on each fields definition, associating each field's child element to this

substitutionGroups - The list of the QName of the substitution groups that the current element is acceptable

Method Detail

getElementName

public String getElementName()

Returns:

the name of this xml element

getNamespace

public String getNamespace()

Returns:

the namespace of this xml element

getNamespaceUri

public String getNamespaceUri()

Returns:

the namespace URI of this xml element

isWrapped

public boolean isWrapped()

Returns:

false if the element implements the Component's type as an xml extension, or true if the element is a wrapper of a ref to the Component's type

getAttributeName

public String getAttributeName()

Returns:

the name of the attribute in the parent element that references this element

supportsChildDeclaration

public boolean supportsChildDeclaration()

Returns:

true if this element supports to be declared as a child element of its parent

supportsTopLevelDeclaration

public boolean supportsTopLevelDeclaration()

Returns:

true if this element supports to be declared as a top level element

getAbstractElementName

public String getAbstractElementName()

Returns:

the name of the abstract element

getSubstitutionGroups

public List<QName> getSubstitutionGroups()

Returns:

List the list of the QName of the substitution groups that this element could be placed

getGeneric

public Optional<DslElementSyntax> getGeneric(org.mule.metadata.api.model.MetadataType type)

Parameters:

type - MetadataType of the generic for which its dsl is required

Returns:

the dsl for the given generic's type if one is present

getChild

public Optional<DslElementSyntax> getChild(String name)

Parameters:

name - name of the child element for which its dsl is required

Returns:

the dsl of the child if one is present

requiresConfig

public boolean requiresConfig()

Returns:

true if this element requires having an attribute which points to a config