ComponentBuildingDefinition (Mule module DSL API 1.5.0-rc3 API)

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ComponentBuildingDefinition.Builder<T>
Builder for ComponentBuildingDefinition

Nested Classes
Modifier and Type	Class and Description
`static class`	`ComponentBuildingDefinition.Builder<T>` Builder for `ComponentBuildingDefinition`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_TYPE_CONVERTER_AND_NO_MAP_TYPE`
`static String`	`TYPE_CONVERTER_AND_NO_SIMPLE_TYPE_MESSAGE_TEMPLATE`
`static String`	`TYPE_CONVERTER_AND_UNKNOWN_TYPE_MESSAGE`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`List<AttributeDefinition>`	`getAttributesDefinitions()`
`org.mule.runtime.api.component.ComponentIdentifier`	`getComponentIdentifier()`
`List<AttributeDefinition>`	`getConstructorAttributeDefinition()`
`Set<String>`	`getIgnoredConfigurationParameters()`
`Optional<TypeConverter>`	`getKeyTypeConverter()`
`Class<? extends ObjectFactory<T>>`	`getObjectFactoryType()`
`String`	`getRegistrationName()`
`List<SetterAttributeDefinition>`	`getSetterParameterDefinitions()`
`Optional<TypeConverter>`	`getTypeConverter()`
`TypeDefinition`	`getTypeDefinition()`
`boolean`	`isAlwaysEnabled()` Deprecated. since 4.4. No longer used. stereotypes are used to determine this.
`boolean`	`isNamed()`
`boolean`	`isPrototype()`
`boolean`	`isScope()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TYPE_CONVERTER_AND_UNKNOWN_TYPE_MESSAGE
```
public static final String TYPE_CONVERTER_AND_UNKNOWN_TYPE_MESSAGE
```
    See Also:
    
    Constant Field Values
  - TYPE_CONVERTER_AND_NO_SIMPLE_TYPE_MESSAGE_TEMPLATE
```
public static final String TYPE_CONVERTER_AND_NO_SIMPLE_TYPE_MESSAGE_TEMPLATE
```
    See Also:
    
    Constant Field Values
  - KEY_TYPE_CONVERTER_AND_NO_MAP_TYPE
```
public static final String KEY_TYPE_CONVERTER_AND_NO_MAP_TYPE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - 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

Class ComponentBuildingDefinition<T>

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_CONVERTER_AND_UNKNOWN_TYPE_MESSAGE

TYPE_CONVERTER_AND_NO_SIMPLE_TYPE_MESSAGE_TEMPLATE

KEY_TYPE_CONVERTER_AND_NO_MAP_TYPE

Method Detail

getTypeDefinition

isScope

getConstructorAttributeDefinition

getSetterParameterDefinitions

getIgnoredConfigurationParameters

getObjectFactoryType

isPrototype

getComponentIdentifier

getTypeConverter

getKeyTypeConverter

isAlwaysEnabled

isNamed

getRegistrationName

getAttributesDefinitions