org.mule.runtime.api.meta.model

Class ExternalLibraryModel.ExternalLibraryModelBuilder

java.lang.Object

org.mule.runtime.api.meta.model.ExternalLibraryModel.ExternalLibraryModelBuilder

Enclosing class:

ExternalLibraryModel

public static class ExternalLibraryModel.ExternalLibraryModelBuilder
extends Object

A Builder for creating instances of ExternalLibraryModel.

Instances are to be created through the ExternalLibraryModel.builder() method. Instances are not reusable.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
ExternalLibraryModel	build()
ExternalLibraryModel.ExternalLibraryModelBuilder	isOptional(boolean optional) Indicates if the library is optional or not.
ExternalLibraryModel.ExternalLibraryModelBuilder	withCoordinates(String coordinates) Suggests Maven coordinates where the required library can be found.
ExternalLibraryModel.ExternalLibraryModelBuilder	withDescription(String description) Sets a description for the library
ExternalLibraryModel.ExternalLibraryModelBuilder	withName(String name) Sets the name of the library.
ExternalLibraryModel.ExternalLibraryModelBuilder	withRegexpMatcher(String regexMatcher) Sets a regexp which must match the name of the library's file.
ExternalLibraryModel.ExternalLibraryModelBuilder	withRequiredClassName(String requiredClassName) If provided, the library should contain a class of the given name
ExternalLibraryModel.ExternalLibraryModelBuilder	withType(ExternalLibraryType type) If provided, set the library's type of dependency

Methods inherited from class java.lang.Object

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

Method Detail

withName

public ExternalLibraryModel.ExternalLibraryModelBuilder withName(String name)

Sets the name of the library. It is mandatory to supply a name.

Parameters:

name - the library name

Returns:

this builder

Throws:

IllegalArgumentException - if name is null

withDescription

public ExternalLibraryModel.ExternalLibraryModelBuilder withDescription(String description)

Sets a description for the library

Parameters:

description - the library's description

Returns:

this builder

withRegexpMatcher

public ExternalLibraryModel.ExternalLibraryModelBuilder withRegexpMatcher(String regexMatcher)

Sets a regexp which must match the name of the library's file.

Parameters:

regexMatcher - a regexp to match the library's filename

Returns:

this builder

withRequiredClassName

public ExternalLibraryModel.ExternalLibraryModelBuilder withRequiredClassName(String requiredClassName)

If provided, the library should contain a class of the given name

Parameters:

requiredClassName - the name of the required class

Returns:

this builder

withType

public ExternalLibraryModel.ExternalLibraryModelBuilder withType(ExternalLibraryType type)

If provided, set the library's type of dependency

Parameters:

type - the type of the library

Returns:

this builder

withCoordinates

public ExternalLibraryModel.ExternalLibraryModelBuilder withCoordinates(String coordinates)

Suggests Maven coordinates where the required library can be found. This coordinates should follow the Maven convention: groupId:artifactId:packaging:classifier:version.

Keep in mind that not all the values of the coordinates are required, for example: org.mule.modules:a-required-lib:1.0.0 are valid coordinates, which communicates the groupId, artifactId and version of the external library.

By default, the packaging is jar, so if is required to use a native library, like a .DLL, you will provide: org.mule.module:a-native-lib:dll:1.0.0 where dll is the packaging of the library.

More information in: https://maven.apache.org/pom.html#Maven_Coordinates

Parameters:

coordinates - The library coordinates

Returns:

this builder

isOptional

public ExternalLibraryModel.ExternalLibraryModelBuilder isOptional(boolean optional)

Indicates if the library is optional or not.

Parameters:

optional - boolean indicating the optionality of the library

Returns:

this builder

build

public ExternalLibraryModel build()

Returns:

a new ExternalLibraryModel instance

Throws:

IllegalStateException - if withName(String) was not provided