Module org.mule.runtime.dsl.api
Package org.mule.runtime.dsl.api.component

Class ComponentBuildingDefinition<T>

java.lang.Object
org.mule.runtime.dsl.api.component.ComponentBuildingDefinition<T>
Type Parameters:
T - the actual type of the runtime object to be created.
public class ComponentBuildingDefinition<T> extends Object
Defines the mapping between a component configuration and how the object that represents that model in runtime is created.
Since:
4.0

  • Field Details

    • TYPE_CONVERTER_AND_UNKNOWN_TYPE_MESSAGE

      public static final String TYPE_CONVERTER_AND_UNKNOWN_TYPE_MESSAGE
      See Also:

    • TYPE_CONVERTER_AND_NO_SIMPLE_TYPE_MESSAGE_TEMPLATE

      public static final String TYPE_CONVERTER_AND_NO_SIMPLE_TYPE_MESSAGE_TEMPLATE
      See Also:

    • KEY_TYPE_CONVERTER_AND_NO_MAP_TYPE

      public static final String KEY_TYPE_CONVERTER_AND_NO_MAP_TYPE
      See Also:

  • Method Details

    • getTypeDefinition

      public TypeDefinition getTypeDefinition()
      Returns:
      a definition for the object type that must be created for this component

    • isScope

      public boolean isScope()
      Returns:
      true if the building definition is an scope of message processors

    • getConstructorAttributeDefinition

      public List<AttributeDefinition> getConstructorAttributeDefinition()
      Returns:
      an ordered list of the constructor parameters that must be set to create the domain object

    • getSetterParameterDefinitions

      public List<SetterAttributeDefinition> getSetterParameterDefinitions()
      Returns:
      a list of the attributes and its definitions that may contain configuration for the domain object to be created.

    • getIgnoredConfigurationParameters

      public Set<String> getIgnoredConfigurationParameters()

    • getObjectFactoryType

      public Class<? extends ObjectFactory<T>> getObjectFactoryType()
      Returns:
      the factory for the domain object. For complex object creations it's possible to define an object builder that will end up creating the domain object.

    • isPrototype

      public boolean isPrototype()
      Returns:
      if the object is a prototype or a singleton

    • getComponentIdentifier

      public org.mule.runtime.api.component.ComponentIdentifier getComponentIdentifier()
      Returns:
      the unique identifier for this component

    • getTypeConverter

      public Optional<TypeConverter> getTypeConverter()
      Returns:
      a converter to be applied to the configuration value.

    • getKeyTypeConverter

      public Optional<TypeConverter> getKeyTypeConverter()
      Returns:
      a converter to be applied to the configuration key when the element is a map entry.

    • isAlwaysEnabled

      @Deprecated public boolean isAlwaysEnabled()
      Deprecated.
      since 4.4. No longer used. stereotypes are used to determine this.
      Returns:
      if the component should be enabled even if excluded when building a partial application model

    • isNamed

      public boolean isNamed()
      Returns:
      whether the defined component has a name attribute

    • getRegistrationName

      public String getRegistrationName()
      Returns:
      a name if the component is a global singleton, otherwise null

    • getAttributesDefinitions

      public List<AttributeDefinition> getAttributesDefinitions()
      Returns:
      the complete list of AttributeDefinitions