org.mule.runtime.dsl.api.component

Class ComponentBuildingDefinition.Builder<T>

java.lang.Object

org.mule.runtime.dsl.api.component.ComponentBuildingDefinition.Builder<T>

Enclosing class:

ComponentBuildingDefinition<T>

public static class ComponentBuildingDefinition.Builder<T>
extends Object

Builder for ComponentBuildingDefinition

TODO MULE-9693 Improve builder so the copy is not required to reuse the namespace value.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ComponentBuildingDefinition.Builder<T>	asNamed() Used to declare that the object to be created has a name attribute
ComponentBuildingDefinition.Builder<T>	asPrototype()
ComponentBuildingDefinition.Builder<T>	asScope() Used to declare that the object to be created is an scope.
ComponentBuildingDefinition<T>	build() Builds a ComponentBuildingDefinition with the parameters set in the builder.
ComponentBuildingDefinition.Builder<T>	withConstructorParameterDefinition(AttributeDefinition attributeDefinition) Adds a new constructor parameter to be used during the object instantiation.
ComponentBuildingDefinition.Builder<T>	withIdentifier(String identifier) Sets the identifier of the configuration element that this building definition is for.
ComponentBuildingDefinition.Builder<T>	withIgnoredConfigurationParameter(String parameterName) Mark configuration parameters to be ignored when building the component.
ComponentBuildingDefinition.Builder<T>	withKeyTypeConverter(TypeConverter typeConverter) This method allows to convert a map entry key to another type using a converter.
ComponentBuildingDefinition.Builder<T>	withNamespace(String namespace) Sets the namespace of the configuration element that this building definition is for.
ComponentBuildingDefinition.Builder<T>	withObjectFactoryType(Class<? extends ObjectFactory<T>> objectFactoryType) Defines a factory class to be used for creating the object.
ComponentBuildingDefinition.Builder<T>	withSetterParameterDefinition(String fieldName, AttributeDefinition attributeDefinition) Adds a new parameter to be added to the object by using a setter method.
ComponentBuildingDefinition.Builder<T>	withTypeConverter(TypeConverter typeConverter) This method allows to convert a simple type to another type using a converter.
ComponentBuildingDefinition.Builder<T>	withTypeDefinition(TypeDefinition<T> typeDefinition) Sets the TypeDefinition to discover the object type.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withConstructorParameterDefinition

public ComponentBuildingDefinition.Builder<T> withConstructorParameterDefinition(AttributeDefinition attributeDefinition)

Adds a new constructor parameter to be used during the object instantiation.

Parameters:

attributeDefinition - the constructor argument definition.

Returns:

this builder

withSetterParameterDefinition

public ComponentBuildingDefinition.Builder<T> withSetterParameterDefinition(String fieldName,
                                                                            AttributeDefinition attributeDefinition)

Adds a new parameter to be added to the object by using a setter method.

Parameters:

fieldName - the name of the field in which the value must be injected

attributeDefinition - the setter parameter definition

Returns:

this builder

withIdentifier

public ComponentBuildingDefinition.Builder<T> withIdentifier(String identifier)

Sets the identifier of the configuration element that this building definition is for. For instance, a config element has as identifier listener

Parameters:

identifier - configuration element identifier

Returns:

this builder

withNamespace

public ComponentBuildingDefinition.Builder<T> withNamespace(String namespace)

Sets the namespace of the configuration element that this building definition is for. For instance, a config element has as namespace http

Parameters:

namespace - configuration element namespace

Returns:

this builder

withTypeDefinition

public ComponentBuildingDefinition.Builder<T> withTypeDefinition(TypeDefinition<T> typeDefinition)

Sets the TypeDefinition to discover the object type. It may be created from TypeDefinition.fromType(Class) which means the type is predefined. Or it may be created from TypeDefinition.fromConfigurationAttribute(String) which means that the object type is declared within the configuration using a config attribute.

Parameters:

typeDefinition - the type definition to discover the objecvt type

Returns:

this builder

withTypeConverter

public ComponentBuildingDefinition.Builder<T> withTypeConverter(TypeConverter typeConverter)

This method allows to convert a simple type to another type using a converter. TypeConverter are only allowed when the produce type by the component is any of java primitive types, its wrapper or string.

Parameters:

typeConverter - converter from the configuration value to a custom type.

Returns:

this builder

withKeyTypeConverter

public ComponentBuildingDefinition.Builder<T> withKeyTypeConverter(TypeConverter typeConverter)

This method allows to convert a map entry key to another type using a converter. TypeConverter are only allowed when the produce type by the component is any of java primitive types, its wrapper or string.

Parameters:

typeConverter - converter from the configuration value to a custom type.

Returns:

this builder

asScope

public ComponentBuildingDefinition.Builder<T> asScope()

Used to declare that the object to be created is an scope.

Returns:

this builder

asNamed

public ComponentBuildingDefinition.Builder<T> asNamed()

Used to declare that the object to be created has a name attribute

Returns:

this builder

withObjectFactoryType

public ComponentBuildingDefinition.Builder<T> withObjectFactoryType(Class<? extends ObjectFactory<T>> objectFactoryType)

Defines a factory class to be used for creating the object. This method can be used when the object to be build required complex logic.

Parameters:

objectFactoryType - Class for the factory to use to create the object

Returns:

this builder

withIgnoredConfigurationParameter

public ComponentBuildingDefinition.Builder<T> withIgnoredConfigurationParameter(String parameterName)

Mark configuration parameters to be ignored when building the component. This is mostly useful when AttributeDefinition.Builder.fromUndefinedSimpleAttributes() there are certain configuration parameters that we don't want to included them in the process of building the object.

Parameters:

parameterName - the configuration parameter name.

Returns:

this builder.

build

public ComponentBuildingDefinition<T> build()

Builds a ComponentBuildingDefinition with the parameters set in the builder.

At least the identifier, namespace and type definition must be configured or this method will fail.

Returns:

a fully configured ComponentBuildingDefinition

asPrototype

public ComponentBuildingDefinition.Builder<T> asPrototype()