Package org.jboss.shrinkwrap.api

Class ConfigurationBuilder

java.lang.Object

org.jboss.shrinkwrap.api.ConfigurationBuilder

public class ConfigurationBuilder
extends Object

Mutable construction object for new instances of Configuration. Provides defaults for each property if not specified (null) according to the following:

• executorService - Stay null, none is required and ShrinkWrap will create its own and destroy it when done as needed
• extensionLoader - A new instance of the service extension loader from shrinkwrap-impl

Not thread-safe. When done altering properties here, a new configuration may be constructed by calling upon build().

Version:

$Revision: $

Field Summary

Fields

Modifier and Type	Field	Description
private Iterable<ClassLoader>	classLoaders	ClassLoaders used for extension loading, adding resources, etc
private ExecutorService	executorService	ExecutorService used for all asynchronous operations
private static final String	EXTENSION_LOADER_IMPL	Implementation class name of the default ExtensionLoader to be used
private ExtensionLoader	extensionLoader	Loader mapping archive types to the appropriate underlying implementation
private static final Logger	log	Logger

Constructor Summary

Constructors

Constructor	Description
ConfigurationBuilder()	Creates a new builder initialized to defaults (null) values.

Method Summary

Modifier and Type	Method	Description
Configuration	build()	Builds a new Configuration using the properties contained in this builder.
ConfigurationBuilder	classLoaders(Iterable<ClassLoader> classLoaders)	Sets the ClassLoader used in resolving extension implementations by the ExtensionLoader; other tasks requiring a CL by the Archive
(package private) ExtensionLoader	createDefaultExtensionLoader()	Obtains the default ExtensionLoader to be used if none is specified
ConfigurationBuilder	executorService(ExecutorService executorService)	Sets the ExecutorService to be used, returning this instance
ConfigurationBuilder	extensionLoader(ExtensionLoader extensionLoader)	Sets the ExtensionLoader to be used, returning this instance
Iterable<ClassLoader>	getClassLoaders()
ExecutorService	getExecutorService()
ExtensionLoader	getExtensionLoader()
(package private) void	setDefaults()	Sets properties to their default values if they haven't been explicitly provided by the user.

Methods inherited from class java.lang.Object

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

Field Details

log

private static final Logger log

Logger

EXTENSION_LOADER_IMPL

private static final String EXTENSION_LOADER_IMPL

Implementation class name of the default ExtensionLoader to be used

See Also:

• Constant Field Values

extensionLoader

private ExtensionLoader extensionLoader

Loader mapping archive types to the appropriate underlying implementation

executorService

private ExecutorService executorService

ExecutorService used for all asynchronous operations

classLoaders

private Iterable<ClassLoader> classLoaders

ClassLoaders used for extension loading, adding resources, etc

Constructor Details

ConfigurationBuilder

public ConfigurationBuilder()

Creates a new builder initialized to defaults (null) values. Any properties not explicitly provided by the user will be defaulted during build().

Method Details

getExtensionLoader

public ExtensionLoader getExtensionLoader()

Returns:

the extensionLoader

getExecutorService

public ExecutorService getExecutorService()

Returns:

the executorService

getClassLoaders

public Iterable<ClassLoader> getClassLoaders()

Returns:

extensionLoader

public ConfigurationBuilder extensionLoader(ExtensionLoader extensionLoader)

Sets the ExtensionLoader to be used, returning this instance

Parameters:

extensionLoader -

Returns:

executorService

public ConfigurationBuilder executorService(ExecutorService executorService)

Sets the ExecutorService to be used, returning this instance

Parameters:

executorService -

Returns:

classLoaders

public ConfigurationBuilder classLoaders(Iterable<ClassLoader> classLoaders)

Sets the ClassLoader used in resolving extension implementations by the ExtensionLoader; other tasks requiring a CL by the Archive

Parameters:

classLoaders -

Returns:

build

public Configuration build()

Builds a new Configuration using the properties contained in this builder. In the case a property has not been specified, it will be defaulted according to the rules set forth in this ConfigurationBuilder's contract.

Returns:

setDefaults

void setDefaults()

Sets properties to their default values if they haven't been explicitly provided by the user. If no ClassLoaders are specified, use the TCCL.

createDefaultExtensionLoader

ExtensionLoader createDefaultExtensionLoader()

Obtains the default ExtensionLoader to be used if none is specified

Returns: