org.jboss.shrinkwrap.resolver.api

Interface ConfigurableResolverSystem<CONFIGUREDRESOLVERSYSTEMTYPE extends ResolverSystem>

Type Parameters:

CONFIGUREDRESOLVERSYSTEMTYPE - View type of the ResolverSystem which does not support configuration

All Superinterfaces:

ResolverSystem

public interface ConfigurableResolverSystem<CONFIGUREDRESOLVERSYSTEMTYPE extends ResolverSystem>
extends ResolverSystem

Top-level of a configurable resolver system; subtypes may be passed in as an argument to Resolvers.use(Class) or Resolvers.use(Class, ClassLoader) to create a new instance.

Author:

Andrew Lee Rubinger

Method Summary

Methods

Modifier and Type	Method and Description
CONFIGUREDRESOLVERSYSTEMTYPE	configureFromClassloaderResource(String path) Optional operation.
CONFIGUREDRESOLVERSYSTEMTYPE	configureFromClassloaderResource(String path, ClassLoader cl) Optional operation.
CONFIGUREDRESOLVERSYSTEMTYPE	configureFromFile(File file) Optional operation.
CONFIGUREDRESOLVERSYSTEMTYPE	configureFromFile(String pathToFile) Optional operation.

Method Detail

configureFromFile

CONFIGUREDRESOLVERSYSTEMTYPE configureFromFile(File file)
                                                                      throws IllegalArgumentException,
                                                                             UnsupportedOperationException,
                                                                             InvalidConfigurationFileException

Optional operation. Configures this ConfigurableResolverSystem from the specified file

Parameters:

file -

Returns:

This configured ResolverSystem

Throws:

IllegalArgumentException - If the file is not specified, is a directory, or does not exist

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

UnsupportedOperationException - If this ConfigurableResolverSystem does not support configuration by File

configureFromFile

CONFIGUREDRESOLVERSYSTEMTYPE configureFromFile(String pathToFile)
                                                                      throws IllegalArgumentException,
                                                                             UnsupportedOperationException,
                                                                             InvalidConfigurationFileException

Optional operation. Configures this ConfigurableResolverSystem from the file at the specified path

Parameters:

pathToFile -

Returns:

This configured ResolverSystem

Throws:

IllegalArgumentException - If the file is not specified, is a directory, or does not exist

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

UnsupportedOperationException - If this ConfigurableResolverSystem does not support configuration by File

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

configureFromClassloaderResource

CONFIGUREDRESOLVERSYSTEMTYPE configureFromClassloaderResource(String path)
                                                                                     throws IllegalArgumentException,
                                                                                            UnsupportedOperationException,
                                                                                            InvalidConfigurationFileException

Optional operation. Configures this ConfigurableResolverSystem from the result of ClassLoader.getResource(String) using the current Thread.getContextClassLoader()

Parameters:

path -

Returns:

This configured ResolverSystem

Throws:

IllegalArgumentException - If the either argument is not specified or if the path can not be found

UnsupportedOperationException - If this ConfigurableResolverSystem does not support configuration by ClassLoader resource

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

configureFromClassloaderResource

CONFIGUREDRESOLVERSYSTEMTYPE configureFromClassloaderResource(String path,
                                                            ClassLoader cl)
                                                                                     throws IllegalArgumentException,
                                                                                            UnsupportedOperationException,
                                                                                            InvalidConfigurationFileException

Optional operation. Configures this ConfigurableResolverSystem from the result of ClassLoader.getResource(String) using the specified ClassLoader

Parameters:

path -

cl -

Returns:

This configured ResolverSystem

Throws:

IllegalArgumentException - If the either argument is not specified or if the path can not be found

UnsupportedOperationException - If this ConfigurableResolverSystem does not support configuration by ClassLoader resource

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format