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

Annotation Type TypeDsl

@MinMuleVersion(value="4.1")
 @Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
public @interface TypeDsl

Allows setting directives regarding syntax and semantics of the generated XML DSL.

Since:

1.0

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allowInlineDefinition Whether the associated element should support inline definition as child element.
boolean	allowTopLevelDefinition Whether the associated element should support being defined as a top level element.
String	baseType Specifies that the annotated type should extend from an specific baseType If the namespace prefix does not exist or the string doesn't match the required format, an IllegalArgumentException will be thrown.
String	substitutionGroup Specifies that the annotated element should extend a particular substitution group.

Element Detail

allowInlineDefinition

public abstract boolean allowInlineDefinition

Whether the associated element should support inline definition as child element. Defaults to true

Default:

true

allowTopLevelDefinition

public abstract boolean allowTopLevelDefinition

Whether the associated element should support being defined as a top level element. This directive only makes sense when the annotation is applied on a type level, on a class which is being used as a complex parameter. Defaults to false

Default:

false

substitutionGroup

public abstract String substitutionGroup

Specifies that the annotated element should extend a particular substitution group. The format expected is prefix:element where the prefix should correspond to an existent one related to an imported namespace. The element should belong to the namespace related to that prefix. If the namespace prefix does not exist or the string doesn't match the required format, an IllegalArgumentException will be thrown.

Default:

""

baseType

public abstract String baseType

Specifies that the annotated type should extend from an specific baseType If the namespace prefix does not exist or the string doesn't match the required format, an IllegalArgumentException will be thrown.

Returns:

the baseType defined or the default

Default:

""