org.mule.runtime.extension.xml.dsl.internal

Class DslElementSyntaxBuilder

java.lang.Object

org.mule.runtime.extension.xml.dsl.internal.DslElementSyntaxBuilder

public final class DslElementSyntaxBuilder
extends Object

Implementation of the builder design pattern to create instances of DslElementSyntax

Since:

1.0

Method Summary

Modifier and Type	Method and Description
DslElementSyntaxBuilder	asWrappedElement(boolean isWrapped) Declares whether or not this DslElementSyntax is a wrapped element.
DslElementSyntax	build()
static DslElementSyntaxBuilder	create()
DslElementSyntaxBuilder	ofSubstitutionGroup(QName substitutionGroupName) Adds a QName indicating that the element described by this builder could be placed in the given substitution group name
DslElementSyntaxBuilder	requiresConfig(boolean requiresConfig) Declares whether or not this DslElementSyntax requires a parameter pointing to a config
DslElementSyntaxBuilder	supportsChildDeclaration(boolean supportsChild) Declares whether or not this DslElementSyntax supports to be declared as child element in the context for which it was created.
DslElementSyntaxBuilder	supportsTopLevelDeclaration(boolean supportsTop) Declares whether or not this DslElementSyntax supports to be declared as top level element in the context for which it was created.
DslElementSyntaxBuilder	withAbstractElementName(String name) Adds the abstract element name to the element being declared
DslElementSyntaxBuilder	withAttributeName(String attributeName) Adds a name that describes how this element will be represented as an attribute.
DslElementSyntaxBuilder	withChild(String name, DslElementSyntax child) Adds a childElement declaration to this DslElementSyntax that can be referenced by name
DslElementSyntaxBuilder	withElementName(String elementName) Adds a name to the element being declared
DslElementSyntaxBuilder	withGeneric(org.mule.metadata.api.model.MetadataType type, DslElementSyntax child) Adds a childElement declaration to this DslElementSyntax that represents a generic type of this element.
DslElementSyntaxBuilder	withNamespace(String nameSpace, String nameSpaceUri) Adds a nameSpace to the element being declared

Methods inherited from class java.lang.Object

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

Method Detail

create

public static DslElementSyntaxBuilder create()

Returns:

a new instance of DslElementSyntaxBuilder

withAttributeName

public DslElementSyntaxBuilder withAttributeName(String attributeName)

Adds a name that describes how this element will be represented as an attribute.

Returns:

this builder instance enriched with the attributeName

withElementName

public DslElementSyntaxBuilder withElementName(String elementName)

Adds a name to the element being declared

Returns:

this builder instance enriched with the elementName

withNamespace

public DslElementSyntaxBuilder withNamespace(String nameSpace,
                                             String nameSpaceUri)

Adds a nameSpace to the element being declared

Returns:

this builder instance enriched with the nameSpace

asWrappedElement

public DslElementSyntaxBuilder asWrappedElement(boolean isWrapped)

Declares whether or not this DslElementSyntax is a wrapped element.

Returns:

this builder instance enriched with the isWrapped

supportsChildDeclaration

public DslElementSyntaxBuilder supportsChildDeclaration(boolean supportsChild)

Declares whether or not this DslElementSyntax supports to be declared as child element in the context for which it was created.

Returns:

this builder instance enriched with supportsChildDeclaration

supportsTopLevelDeclaration

public DslElementSyntaxBuilder supportsTopLevelDeclaration(boolean supportsTop)

Declares whether or not this DslElementSyntax supports to be declared as top level element in the context for which it was created.

Returns:

this builder instance enriched with supportsTopLevelDeclaration

requiresConfig

public DslElementSyntaxBuilder requiresConfig(boolean requiresConfig)

Declares whether or not this DslElementSyntax requires a parameter pointing to a config

Returns:

this builder instance enriched with supportsTopLevelDeclaration

withGeneric

public DslElementSyntaxBuilder withGeneric(org.mule.metadata.api.model.MetadataType type,
                                           DslElementSyntax child)

Adds a childElement declaration to this DslElementSyntax that represents a generic type of this element.

Returns:

this builder instance enriched with the typed childElement

ofSubstitutionGroup

public DslElementSyntaxBuilder ofSubstitutionGroup(QName substitutionGroupName)

Adds a QName indicating that the element described by this builder could be placed in the given substitution group name

Parameters:

substitutionGroupName - QName of the substitution group

Returns:

this builder instance enriched with the QName indicating a substitution group of the childElement

withChild

public DslElementSyntaxBuilder withChild(String name,
                                         DslElementSyntax child)

Adds a childElement declaration to this DslElementSyntax that can be referenced by name

Returns:

this builder instance enriched with the named childElement

withAbstractElementName

public DslElementSyntaxBuilder withAbstractElementName(String name)

Adds the abstract element name to the element being declared

Parameters:

name - of the abstract element

Returns:

this builder instance enriched with the name

build

public DslElementSyntax build()

Returns:

a new instance of DslElementSyntax