org.mule.runtime.api.meta.model.declaration.fluent

Class ExtensionDeclarer

java.lang.Object

org.mule.runtime.api.meta.model.declaration.fluent.Declarer<ExtensionDeclaration>

org.mule.runtime.api.meta.model.declaration.fluent.ExtensionDeclarer

All Implemented Interfaces:

DeclaresExternalLibraries<ExtensionDeclarer>, HasConnectionProviderDeclarer, HasConstructDeclarer<ExtensionDeclarer>, HasFunctionDeclarer, HasModelProperties<ExtensionDeclarer>, HasOperationDeclarer, HasSourceDeclarer

public class ExtensionDeclarer
extends Declarer<ExtensionDeclaration>
implements HasModelProperties<ExtensionDeclarer>, HasOperationDeclarer, HasFunctionDeclarer, HasConnectionProviderDeclarer, HasSourceDeclarer, DeclaresExternalLibraries<ExtensionDeclarer>, HasConstructDeclarer<ExtensionDeclarer>

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

Since:

1.0

Field Summary

Fields inherited from class org.mule.runtime.api.meta.model.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	withConstruct(ConstructDeclarer declarer) Adds an ConstructDeclaration by receiving a declarer which describes it
ConstructDeclarer	withConstruct(String name) Adds a construct of the given name
ExtensionDeclarer	withErrorModel(ErrorModel errorModel) Registers an ErrorModel that could be thrown by one their operations
ExtensionDeclarer	withExternalLibrary(ExternalLibraryModel externalLibrary) Adds the given externalLibrary
void	withFunction(FunctionDeclarer declarer) Adds a FunctionDeclaration by receiving a declarer which describes it
FunctionDeclarer	withFunction(String name) Adds a function of the given name
ExtensionDeclarer	withImportedType(ImportedTypeModel importedType) Declares that the extension is importing a type from another extension
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(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	withPrivilegedArtifact(String artifactId) Adds the given artifact ID to the list of artifacts with access to the privileged API declared by the extension begin built
ExtensionDeclarer	withPrivilegedPackage(String packageName) Adds the given Java package name to the list of privileged exported packages declared by the extension begin built
ExtensionDeclarer	withResource(String resourcePath) Adds the given resourcePath to the list of resources declared by the extension being built
ExtensionDeclarer	withSubType(org.mule.metadata.api.model.MetadataType baseType, org.mule.metadata.api.model.MetadataType subType) Registers the given subType as an implementation of the baseType
ExtensionDeclarer	withSubTypes(org.mule.metadata.api.model.MetadataType baseType, Collection<org.mule.metadata.api.model.MetadataType> subTypes) Registers the given subTypes as implementations of the baseType
ExtensionDeclarer	withType(org.mule.metadata.api.model.ObjectType objectType) Adds the given objectType to the list of types declared by the extension being built.
ExtensionDeclarer	withXmlDsl(XmlDslModel xmlDslModel) Describes the language which allows using the extension

Methods inherited from class org.mule.runtime.api.meta.model.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

withConstruct

public ConstructDeclarer withConstruct(String name)

Adds a construct of the given name

Specified by:

withConstruct in interface HasConstructDeclarer<ExtensionDeclarer>

Parameters:

name - a non blank name

Returns:

a ConstructDeclarer which allows describing the created construct

withConstruct

public ExtensionDeclarer withConstruct(ConstructDeclarer declarer)

Description copied from interface: HasConstructDeclarer

Adds an ConstructDeclaration by receiving a declarer which describes it

Specified by:

withConstruct in interface HasConstructDeclarer<ExtensionDeclarer>

Parameters:

declarer - a ConstructDeclaration

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

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

withPrivilegedPackage

public ExtensionDeclarer withPrivilegedPackage(String packageName)

Adds the given Java package name to the list of privileged exported packages declared by the extension begin built

Parameters:

packageName - package to export on the privileged plugin's API

Returns:

this declarer

withPrivilegedArtifact

public ExtensionDeclarer withPrivilegedArtifact(String artifactId)

Adds the given artifact ID to the list of artifacts with access to the privileged API declared by the extension begin built

Parameters:

artifactId - artifact ID that will have access to the privileged plugin's API

Returns:

this declarer

withResource

public ExtensionDeclarer withResource(String resourcePath)

Adds the given resourcePath to the list of resources declared by the extension being built

Parameters:

resourcePath - the relative path to the extension's resource

Returns:

this declarer

withImportedType

public ExtensionDeclarer withImportedType(ImportedTypeModel importedType)

Declares that the extension is importing a type from another extension

Parameters:

importedType - a ImportedTypeModel with the import information

Returns:

this declarer

withXmlDsl

public ExtensionDeclarer withXmlDsl(XmlDslModel xmlDslModel)

Describes the language which allows using the extension

Parameters:

xmlDslModel - an XmlDslModel

Returns:

this declarer

withSubType

public ExtensionDeclarer withSubType(org.mule.metadata.api.model.MetadataType baseType,
                                     org.mule.metadata.api.model.MetadataType subType)

Registers the given subType as an implementation of the baseType

Parameters:

baseType - a base type

subType - a sub type implementation

Returns:

this declarer

withSubTypes

public ExtensionDeclarer withSubTypes(org.mule.metadata.api.model.MetadataType baseType,
                                      Collection<org.mule.metadata.api.model.MetadataType> subTypes)

Registers the given subTypes as implementations of the baseType

Parameters:

baseType - a base type

subTypes - a Collection of sub type implementations

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(MuleVersion minMuleVersion)

Adds the extension's minimum Mule Version

Parameters:

minMuleVersion - of the extension

Returns:

this descriptor

withErrorModel

public ExtensionDeclarer withErrorModel(ErrorModel errorModel)

Registers an ErrorModel that could be thrown by one their operations

Parameters:

errorModel - to add

Returns:

this descriptor

withExternalLibrary

public ExtensionDeclarer withExternalLibrary(ExternalLibraryModel externalLibrary)

Adds the given externalLibrary

Specified by:

withExternalLibrary in interface DeclaresExternalLibraries<ExtensionDeclarer>

Parameters:

externalLibrary - the ExternalLibraryModel to be referenced

Returns:

this instance

withFunction

public FunctionDeclarer withFunction(String name)

Adds a function of the given name

Specified by:

withFunction in interface HasFunctionDeclarer

Parameters:

name - a non blank name

Returns:

a OperationDeclarer which allows describing the created operation

withFunction

public void withFunction(FunctionDeclarer declarer)

Adds a FunctionDeclaration by receiving a declarer which describes it

Specified by:

withFunction in interface HasFunctionDeclarer

Parameters:

declarer - a FunctionDeclarer