org.mule.runtime.extension.api.introspection.declaration.fluent

Class ExtensionDeclarer

java.lang.Object

org.mule.runtime.extension.api.introspection.declaration.fluent.Declarer<ExtensionDeclaration>

org.mule.runtime.extension.api.introspection.declaration.fluent.ExtensionDeclarer

All Implemented Interfaces:

HasConnectionProviderDeclarer, HasExceptionEnricher<ExtensionDeclarer>, HasModelProperties<ExtensionDeclarer>, HasOperationDeclarer, HasSourceDeclarer

public class ExtensionDeclarer
extends Declarer<ExtensionDeclaration>
implements HasModelProperties<ExtensionDeclarer>, HasExceptionEnricher<ExtensionDeclarer>, HasOperationDeclarer, HasConnectionProviderDeclarer, HasSourceDeclarer

A builder object which allows creating an ExtensionDeclaration through a fluent API.

Since:

1.0

Field Summary

Fields inherited from class org.mule.runtime.extension.api.introspection.declaration.fluent.Declarer

declaration

Constructor Summary

Constructors

Constructor and Description
ExtensionDeclarer() Constructor for this descriptor

Method Summary

Modifier and Type	Method and Description
ExtensionDeclarer	describedAs(String description) Adds a description
ExtensionDeclarer	fromVendor(String vendor) Adds the extension's Vendor name
ExtensionDeclarer	named(String name) Provides the extension's name
ExtensionDeclarer	onVersion(String version) Provides the extension's version
ExtensionDeclarer	withCategory(Category category) Adds the extension's Category
ConfigurationDeclarer	withConfig(String name) Adds a config of the given name
void	withConnectionProvider(ConnectionProviderDeclarer declarer) Adds a ConnectionProviderDeclaration by receiving a declarer which describes it
ConnectionProviderDeclarer	withConnectionProvider(String name) Adds a connection provider of the given name
ExtensionDeclarer	withExceptionEnricherFactory(Optional<ExceptionEnricherFactory> enricherFactory) Provides the given ExceptionEnricherFactory
void	withMessageSource(SourceDeclarer declarer) Adds a SourceDeclaration by receiving a declarer which describes it
SourceDeclarer	withMessageSource(String name) Adds a message source of the given name
ExtensionDeclarer	withMinMuleVersion(org.mule.runtime.api.MuleVersion minMuleVersion) Adds the extension's minimum Mule Version
ExtensionDeclarer	withModelProperty(ModelProperty value) Adds the given modelProperty
void	withOperation(OperationDeclarer declarer) Adds an OperationDeclaration by receiving a declarer which describes it
OperationDeclarer	withOperation(String name) Adds an operation of the given name
ExtensionDeclarer	withType(org.mule.metadata.api.model.ObjectType objectType) Adds the given objectType to the list of types declared by the extension being built.

Methods inherited from class org.mule.runtime.extension.api.introspection.declaration.fluent.Declarer

getDeclaration

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtensionDeclarer

public ExtensionDeclarer()

Constructor for this descriptor

Method Detail

named

public ExtensionDeclarer named(String name)

Provides the extension's name

Parameters:

name - the extension's name

Returns:

this descriptor

onVersion

public ExtensionDeclarer onVersion(String version)

Provides the extension's version

Parameters:

version - the extensions version

Returns:

this descriptor

describedAs

public ExtensionDeclarer describedAs(String description)

Adds a description

Parameters:

description - a description

Returns:

this descriptor

withConfig

public ConfigurationDeclarer withConfig(String name)

Adds a config of the given name

Parameters:

name - a non blank name

Returns:

a ConfigurationDeclarer which allows describing the created configuration

withConnectionProvider

public ConnectionProviderDeclarer withConnectionProvider(String name)

Adds a connection provider of the given name

Specified by:

withConnectionProvider in interface HasConnectionProviderDeclarer

Parameters:

name - a non blank name

Returns:

a ConnectionProviderDeclarer which allows describing the created provider

withConnectionProvider

public void withConnectionProvider(ConnectionProviderDeclarer declarer)

Adds a ConnectionProviderDeclaration by receiving a declarer which describes it

Specified by:

withConnectionProvider in interface HasConnectionProviderDeclarer

Parameters:

declarer - a ConnectionProviderDeclarer

withOperation

public OperationDeclarer withOperation(String name)

Adds an operation of the given name

Specified by:

withOperation in interface HasOperationDeclarer

Parameters:

name - a non blank name

Returns:

a OperationDeclarer which allows describing the created operation

withOperation

public void withOperation(OperationDeclarer declarer)

Adds an OperationDeclaration by receiving a declarer which describes it

Specified by:

withOperation in interface HasOperationDeclarer

Parameters:

declarer - a OperationDeclaration

withMessageSource

public SourceDeclarer withMessageSource(String name)

Adds a message source of the given name

Specified by:

withMessageSource in interface HasSourceDeclarer

Parameters:

name - a non blank name

Returns:

a SourceDeclarer which allows describing the created provider

withMessageSource

public void withMessageSource(SourceDeclarer declarer)

Adds a SourceDeclaration by receiving a declarer which describes it

Specified by:

withMessageSource in interface HasSourceDeclarer

Parameters:

declarer - a SourceDeclarer

withModelProperty

public ExtensionDeclarer withModelProperty(ModelProperty value)

Adds the given modelProperty

Specified by:

withModelProperty in interface HasModelProperties<ExtensionDeclarer>

Parameters:

value - a ModelProperty

Returns:

this declarer

withExceptionEnricherFactory

public ExtensionDeclarer withExceptionEnricherFactory(Optional<ExceptionEnricherFactory> enricherFactory)

Provides the given ExceptionEnricherFactory

Specified by:

withExceptionEnricherFactory in interface HasExceptionEnricher<ExtensionDeclarer>

Parameters:

enricherFactory - a concrete ExceptionEnricherFactory

Returns:

this declarer

withType

public ExtensionDeclarer withType(org.mule.metadata.api.model.ObjectType objectType)

Adds the given objectType to the list of types declared by the extension being built.

Parameters:

objectType - an ObjectType

Returns:

this declarer

fromVendor

public ExtensionDeclarer fromVendor(String vendor)

Adds the extension's Vendor name

Parameters:

vendor - name

Returns:

this descriptor

withCategory

public ExtensionDeclarer withCategory(Category category)

Adds the extension's Category

Parameters:

category - of the extension

Returns:

this descriptor

withMinMuleVersion

public ExtensionDeclarer withMinMuleVersion(org.mule.runtime.api.MuleVersion minMuleVersion)

Adds the extension's minimum Mule Version

Parameters:

minMuleVersion - of the extension

Returns:

this descriptor