org.mule.runtime.config.internal.model

Class ComponentModel.Builder

java.lang.Object

org.mule.runtime.config.internal.model.ComponentModel.Builder

Enclosing class:

ComponentModel

public static class ComponentModel.Builder
extends Object

Builder to create instances of ComponentModel.

Constructor Summary

Constructors

Constructor and Description
Builder() Default constructor for this builder.
Builder(ComponentModel root) Creates an instance of the Builder which will allow to merge other root component models to the given one.

Method Summary

Modifier and Type	Method and Description
ComponentModel.Builder	addChildComponentModel(ComponentModel componentModel) Adds a new complex child object to this ComponentModel.
ComponentModel.Builder	addCustomAttribute(QName qname, Object value) Adds a custom attribute to the ComponentModel.
ComponentModel.Builder	addCustomAttribute(String name, Object value) Adds a custom attribute to the ComponentModel.
ComponentModel.Builder	addParameter(String parameterName, String value, boolean valueFromSchema)
ComponentModel	build()
ComponentModel.Builder	markAsRootComponent() When invoked the created ComponentModel will be marked us a top level configuration.
ComponentModel.Builder	merge(ComponentModel otherRootComponentModel) Given the following root component it will merge its customAttributes, parameters and schemaValueParameters to the root component model.
ComponentModel.Builder	setConfigFileName(String configFileName)
ComponentModel.Builder	setIdentifier(org.mule.runtime.api.component.ComponentIdentifier identifier)
ComponentModel.Builder	setLineNumber(int lineNumber)
ComponentModel.Builder	setSourceCode(String sourceCode)
ComponentModel.Builder	setStartColumn(int startColumn)
ComponentModel.Builder	setTextContent(String textContent) Sets the inner content of the configuration element.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Default constructor for this builder.

Builder

public Builder(ComponentModel root)

Creates an instance of the Builder which will allow to merge other root component models to the given one. The root component model provided here will be modified instead of cloned.

Parameters:

root - ComponentModel to be used as root. It will be modified.

Method Detail

setIdentifier

public ComponentModel.Builder setIdentifier(org.mule.runtime.api.component.ComponentIdentifier identifier)

Parameters:

identifier - identifier for the configuration element this object represents.

Returns:

the builder.

addParameter

public ComponentModel.Builder addParameter(String parameterName,
                                           String value,
                                           boolean valueFromSchema)

Parameters:

parameterName - name of the configuration parameter.

value - value contained by the configuration parameter.

valueFromSchema -

Returns:

the builder.

addChildComponentModel

public ComponentModel.Builder addChildComponentModel(ComponentModel componentModel)

Adds a new complex child object to this ComponentModel.

Parameters:

componentModel - child ComponentModel declared in the configuration.

Returns:

the builder.

setTextContent

public ComponentModel.Builder setTextContent(String textContent)

Sets the inner content of the configuration element.

Parameters:

textContent - inner text content from the configuration.

Returns:

the builder.

markAsRootComponent

public ComponentModel.Builder markAsRootComponent()

When invoked the created ComponentModel will be marked us a top level configuration.

Returns:

the builder.

addCustomAttribute

public ComponentModel.Builder addCustomAttribute(String name,
                                                 Object value)

Adds a custom attribute to the ComponentModel. This custom attribute is meant to hold metadata of the configuration and not to be used to instantiate the runtime object that corresponds to this configuration.

Parameters:

name - custom attribute name.

value - custom attribute value.

Returns:

the builder.

addCustomAttribute

public ComponentModel.Builder addCustomAttribute(QName qname,
                                                 Object value)

Adds a custom attribute to the ComponentModel. This custom attribute is meant to hold metadata of the configuration and not to be used to instantiate the runtime object that corresponds to this configuration.

Parameters:

name - custom attribute name.

value - custom attribute value.

Returns:

the builder.

setConfigFileName

public ComponentModel.Builder setConfigFileName(String configFileName)

Parameters:

configFileName - the config file name in which this component was defined.

Returns:

the builder.

setLineNumber

public ComponentModel.Builder setLineNumber(int lineNumber)

Parameters:

lineNumber - the line number within the config file in which this component was defined.

Returns:

the builder.

setStartColumn

public ComponentModel.Builder setStartColumn(int startColumn)

Parameters:

startColumn - the start column within the config file in which this component was defined.

Returns:

the builder.

setSourceCode

public ComponentModel.Builder setSourceCode(String sourceCode)

Parameters:

sourceCode - the source code associated with this component.

Returns:

the builder.

merge

public ComponentModel.Builder merge(ComponentModel otherRootComponentModel)

Given the following root component it will merge its customAttributes, parameters and schemaValueParameters to the root component model.

Parameters:

otherRootComponentModel - another component model created as root to be merged.

Returns:

the builder.

build

public ComponentModel build()

Returns:

a ComponentModel created based on the supplied parameters.