org.mule.runtime.module.artifact.api.descriptor

Class ClassLoaderModel.ClassLoaderModelBuilder

java.lang.Object

org.mule.runtime.module.artifact.api.descriptor.ClassLoaderModel.ClassLoaderModelBuilder

Enclosing class:

ClassLoaderModel

public static class ClassLoaderModel.ClassLoaderModelBuilder
extends Object

Builds a ClassLoaderModel

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<BundleDependency>	dependencies

Constructor Summary

Constructors

Constructor and Description
ClassLoaderModelBuilder() Creates an empty builder.
ClassLoaderModelBuilder(ClassLoaderModel source) Creates a builder initialized with a ClassLoaderModel's state

Method Summary

Modifier and Type	Method and Description
ClassLoaderModel	build() Creates a ClassLoaderModel with the current configuration.
ClassLoaderModel.ClassLoaderModelBuilder	containing(URL url) Adds an URL to the model
ClassLoaderModel.ClassLoaderModelBuilder	dependingOn(Set<BundleDependency> dependencies) Indicates which dependencies are required for this model.
ClassLoaderModel.ClassLoaderModelBuilder	exportingPackages(Set<String> packages) Indicates which package are exported on the model.
ClassLoaderModel.ClassLoaderModelBuilder	exportingPrivilegedPackages(Set<String> packages, Set<String> artifactIds) Indicates which Java packages are exported as privileged API on the model.
ClassLoaderModel.ClassLoaderModelBuilder	exportingResources(Set<String> resources) Indicates which resource are exported on the model.
ClassLoaderModel.ClassLoaderModelBuilder	includeTestDependencies(boolean includeTestDependencies) Sets this model to include test dependencies on class loader URL resolution.
ClassLoaderModel.ClassLoaderModelBuilder	withLocalPackages(Set<String> packages) Indicates which Java packages are loaded from the artifact itself, even if some other artifact in the region exports it.
ClassLoaderModel.ClassLoaderModelBuilder	withLocalResources(Set<String> resources) Indicates which resources are loaded from the artifact itself, even if some other artifact in the region exports it.

Methods inherited from class java.lang.Object

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

Field Detail

dependencies

protected Set<BundleDependency> dependencies

Constructor Detail

ClassLoaderModelBuilder

public ClassLoaderModelBuilder()

Creates an empty builder.

ClassLoaderModelBuilder

public ClassLoaderModelBuilder(ClassLoaderModel source)

Creates a builder initialized with a ClassLoaderModel's state

Parameters:

source - used to initialize the created object. Non null.

Method Detail

exportingPackages

public ClassLoaderModel.ClassLoaderModelBuilder exportingPackages(Set<String> packages)

Indicates which package are exported on the model.

Parameters:

packages - packages to export. Non null.

Returns:

same builder instance.

exportingResources

public ClassLoaderModel.ClassLoaderModelBuilder exportingResources(Set<String> resources)

Indicates which resource are exported on the model.

Parameters:

resources - resources to export. Non null.

Returns:

same builder instance.

withLocalPackages

public ClassLoaderModel.ClassLoaderModelBuilder withLocalPackages(Set<String> packages)

Indicates which Java packages are loaded from the artifact itself, even if some other artifact in the region exports it.

The reason to use this is a that if a plugin internally uses a certain version of a lib, providing certain packages, another plugin exporting some of those packages must not modify the inner implementation used by the first plugin.

Parameters:

packages - packages to not import. Non null.

Returns:

same builder instance.

withLocalResources

public ClassLoaderModel.ClassLoaderModelBuilder withLocalResources(Set<String> resources)

Indicates which resources are loaded from the artifact itself, even if some other artifact in the region exports it.

The reason to use this is a that if a plugin internally uses a certain version of a lib, providing certain packages, another plugin exporting some of those packages must not modify the inner implementation used by the first plugin.

Parameters:

resources - resources to not import. Non null.

Returns:

same builder instance.

exportingPrivilegedPackages

public ClassLoaderModel.ClassLoaderModelBuilder exportingPrivilegedPackages(Set<String> packages,
                                                                            Set<String> artifactIds)

Indicates which Java packages are exported as privileged API on the model.

Parameters:

packages - Java packages names to export. Non null.

artifactIds - artifact IDs that have access to the privileged API. No null.

Returns:

same builder instance.

dependingOn

public ClassLoaderModel.ClassLoaderModelBuilder dependingOn(Set<BundleDependency> dependencies)

Indicates which dependencies are required for this model.

Parameters:

dependencies - dependencies on which the model depends on. Non null.

Returns:

same builder instance.

containing

public ClassLoaderModel.ClassLoaderModelBuilder containing(URL url)

Adds an URL to the model

Parameters:

url - indicates which resource to add. Non null.

Returns:

same builder instance.

includeTestDependencies

public ClassLoaderModel.ClassLoaderModelBuilder includeTestDependencies(boolean includeTestDependencies)

Sets this model to include test dependencies on class loader URL resolution.

Parameters:

includeTestDependencies - true to include test dependencies.

Returns:

same builder instance.

build

public ClassLoaderModel build()

Creates a ClassLoaderModel with the current configuration.

Returns:

a non null ClassLoaderModel