Module org.mule.runtime.extensions.api

Package org.mule.runtime.extension.api.declaration.type.annotation

Class TypeDslAnnotation

java.lang.Object

org.mule.runtime.extension.api.declaration.type.annotation.TypeDslAnnotation

All Implemented Interfaces:

org.mule.metadata.api.annotation.TypeAnnotation

public class TypeDslAnnotation
extends Object
implements org.mule.metadata.api.annotation.TypeAnnotation

TypeAnnotation storing information defined by TypsDsl annotations

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
TypeDslAnnotation(boolean allowInlineDefinition, boolean allowTopLevelDefinition, String substitutionGroup, String baseType)	Creates a new instance

Method Summary

Modifier and Type	Method	Description
boolean	allowsInlineDefinition()
boolean	allowsTopLevelDefinition()
boolean	equals(Object o)
Optional<DslBaseType>	getDslBaseType()
String	getName()
Optional<SubstitutionGroup>	getSubstitutionGroup()
int	hashCode()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.metadata.api.annotation.TypeAnnotation

isPublic

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

TypeDslAnnotation

public TypeDslAnnotation(boolean allowInlineDefinition,
 boolean allowTopLevelDefinition,
 String substitutionGroup,
 String baseType)

Creates a new instance

Parameters:

allowInlineDefinition - whether the associated element should support inline definition as child element

allowTopLevelDefinition - whether the associated element should support being defined as a top level element

substitutionGroup - the substitutionGroup that the xml element should have as attribute

baseType - the dslBaseType that the type should declare as base attribute

Method Details

getName

public String getName()

Specified by:

getName in interface org.mule.metadata.api.annotation.TypeAnnotation

Returns:

typeDsl

allowsInlineDefinition

public boolean allowsInlineDefinition()

Returns:

whether the associated element should support inline definition as child element

allowsTopLevelDefinition

public boolean allowsTopLevelDefinition()

Returns:

whether the associated element should support being defined as a top level element

getSubstitutionGroup

public Optional<SubstitutionGroup> getSubstitutionGroup()

Returns:

any subtitutionGroup the element might extend from or Optional.empty() if not defined

getDslBaseType

public Optional<DslBaseType> getDslBaseType()

Returns:

any dslBaseType defined for the type to extend from or Optional.empty() it not defined

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object