ComponentModel (Spring Config 4.0.0-FD.2 API)

java.lang.Object
- org.mule.runtime.config.spring.dsl.model.ComponentModel

```
public class ComponentModel
extends Object
```
An ComponentModel represents the user configuration of a component (flow, config, message processor, etc) defined in an artifact configuration file.
Every ComponentModel represents the configuration of a core configuration or an extension configuration. Which configuration element this object represents is identified by a ComponentIdentifier that can be retrieved using #getName.
It may have simple configuration parameters which are retrieve by using #getParameterGroups or complex parameters which are retrieved using #getInnerComponents.
There's a set of configuration attributes or custom attributes that may not be mapped directly to the object that runs on runtime but may be hold by a ComponentModel. Those attributes are retrieved by using #getCustomAttributes.

Since:

4.0

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ComponentModel.Builder
Builder to create instances of ComponentModel.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ComponentModel.Builder` Builder to create instances of `ComponentModel`.

Constructor Summary

Constructors
Constructor and Description

ComponentModel()

Constructors
Constructor and Description
`ComponentModel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`void`	`executedOnEveryInnerComponent(Consumer<ComponentModel> task)` Executes the task on every inner component associated to this componentModel.
`org.springframework.beans.factory.config.BeanDefinition`	`getBeanDefinition()`
`org.springframework.beans.factory.config.BeanReference`	`getBeanReference()`
`DefaultComponentLocation`	`getComponentLocation()`
`Optional<String>`	`getConfigFileName()`
`ComponentConfiguration`	`getConfiguration()`
`Map<String,Object>`	`getCustomAttributes()`
`org.mule.runtime.api.component.ComponentIdentifier`	`getIdentifier()`
`List<ComponentModel>`	`getInnerComponents()`
`Optional<Integer>`	`getLineNumber()`
`String`	`getNameAttribute()`
`Map<String,String>`	`getParameters()`
`ComponentModel`	`getParent()`
`String`	`getTextContent()`
`Class<?>`	`getType()`
`int`	`hashCode()`
`boolean`	`isEnabled()`
`boolean`	`isParameterValueProvidedBySchema(String parameterName)`
`boolean`	`isRoot()`
`boolean`	`isScope()`
`void`	`setBeanDefinition(org.springframework.beans.factory.config.BeanDefinition beanDefinition)`
`void`	`setBeanReference(org.springframework.beans.factory.config.BeanReference beanReference)`
`void`	`setComponentLocation(DefaultComponentLocation componentLocation)`
`void`	`setEnabled(boolean enabled)` Sets the component as enabled, meaning that it should be created and the beanDefinition associated with created too.
`void`	`setParameter(String parameterName, String value)`
`void`	`setParent(ComponentModel parent)`
`void`	`setRoot(boolean root)` Marked as true if it's a top level configuration.
`void`	`setType(Class<?> type)`

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

- Constructor Detail
  - ComponentModel
```
public ComponentModel()
```
- Method Detail
  - getLineNumber
```
public Optional<Integer> getLineNumber()
```
    Returns:
    
    the line number in which the component was defined in the configuration file. It may be empty if the component was created pragmatically.
  - getConfigFileName
```
public Optional<String> getConfigFileName()
```
    Returns:
    
    the config file name in which the component was defined. It may be empty if the component was created pragmatically.
  - getIdentifier
```
public org.mule.runtime.api.component.ComponentIdentifier getIdentifier()
```
    Returns:
    
    the configuration identifier.
  - getParameters
```
public Map<String,String> getParameters()
```
    Returns:
    
    a java.util.Map with the simple parameters of the configuration.
  - getInnerComponents
```
public List<ComponentModel> getInnerComponents()
```
    Returns:
    
    a java.util.List of all the child ComponentModels
  - getCustomAttributes
```
public Map<String,Object> getCustomAttributes()
```
    Returns:
    
    a java.util.Map with all the custom attributes.
  - isRoot
```
public boolean isRoot()
```
    Returns:
    
    true if the ComponentModel is a top level configuration element, false otherwise.
  - setBeanDefinition
```
public void setBeanDefinition(org.springframework.beans.factory.config.BeanDefinition beanDefinition)
```
    Parameters:
    
    beanDefinition - the BeanDefinition created based on the ComponentModel values.
  - setRoot
```
public void setRoot(boolean root)
```
    Marked as true if it's a top level configuration.
  - setParameter
```
public void setParameter(String parameterName,
                         String value)
```
    Parameters:
    
    parameterName - name of the configuration parameter.
    
    value - value contained by the configuration parameter.
  - getBeanDefinition
```
public org.springframework.beans.factory.config.BeanDefinition getBeanDefinition()
```
    Returns:
    
    the BeanDefinition created based on the ComponentModel values.
  - getType
```
public Class<?> getType()
```
    Returns:
    
    the type of the object to be created when processing this ComponentModel.
  - setType
```
public void setType(Class<?> type)
```
    Parameters:
    
    type - the type of the object to be created when processing this ComponentModel.
  - getNameAttribute
```
public String getNameAttribute()
```
    Returns:
    
    the value of the name attribute.
  - isScope
```
public boolean isScope()
```
    Returns:
    
    true if this ComponentModel represents a org.mule.runtime.core.api.processor.MessageProcessor scope.
  - setParent
```
public void setParent(ComponentModel parent)
```
  - getParent
```
public ComponentModel getParent()
```
    Returns:
    
    the parent component model in the configuration.
  - getTextContent
```
public String getTextContent()
```
    Returns:
    
    content of the configuration element.
  - setComponentLocation
```
public void setComponentLocation(DefaultComponentLocation componentLocation)
```
    Parameters:
    
    componentLocation - the location of the component in the configuration.
  - getComponentLocation
```
public DefaultComponentLocation getComponentLocation()
```
    Returns:
    
    the location of the component in the configuration.
  - setBeanReference
```
public void setBeanReference(org.springframework.beans.factory.config.BeanReference beanReference)
```
    Parameters:
    
    beanReference - the BeanReference that represents this object.
  - getBeanReference
```
public org.springframework.beans.factory.config.BeanReference getBeanReference()
```
    Returns:
    
    the BeanReference that represents this object.
  - isParameterValueProvidedBySchema
```
public boolean isParameterValueProvidedBySchema(String parameterName)
```
    Parameters:
    
    parameterName - configuration parameter name
    
    Returns:
    
    true if the value provided for the configuration parameter was get from the DSL schema, false if it was explicitly defined in the config
  - getConfiguration
```
public ComponentConfiguration getConfiguration()
```
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Sets the component as enabled, meaning that it should be created and the beanDefinition associated with created too.
    
    Parameters:
    
    enabled - if this component is enabled and has to be created.
  - executedOnEveryInnerComponent
```
public void executedOnEveryInnerComponent(Consumer<ComponentModel> task)
```
    Executes the task on every inner component associated to this componentModel.
    
    Parameters:
    
    task - to be executed on inner components.
  - isEnabled
```
public boolean isEnabled()
```
    Returns:
    
    true if this component is enabled and has to be created.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ComponentModel

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ComponentModel

Method Detail

getLineNumber

getConfigFileName

getIdentifier

getParameters

getInnerComponents

getCustomAttributes

isRoot

setBeanDefinition

setRoot

setParameter

getBeanDefinition

getType

setType

getNameAttribute

isScope

setParent

getParent

getTextContent

setComponentLocation

getComponentLocation

setBeanReference

getBeanReference

isParameterValueProvidedBySchema

getConfiguration

setEnabled

executedOnEveryInnerComponent

isEnabled

equals

hashCode