org.jboss.shrinkwrap.resolver.api

Interface ConfigurableResolverSystem<CONFIGUREDRESOLVERSYSTEMTYPE extends ResolverSystem,UNCONFIGUREDRESOLVERSYSTEMTYPE extends ConfigurableResolverSystem<CONFIGUREDRESOLVERSYSTEMTYPE,UNCONFIGUREDRESOLVERSYSTEMTYPE>>

Type Parameters:

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

All Superinterfaces:

ResolverSystem

public interface ConfigurableResolverSystem<CONFIGUREDRESOLVERSYSTEMTYPE extends ResolverSystem,UNCONFIGUREDRESOLVERSYSTEMTYPE extends ConfigurableResolverSystem<CONFIGUREDRESOLVERSYSTEMTYPE,UNCONFIGUREDRESOLVERSYSTEMTYPE>>
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

Modifier and Type	Method and Description
CONFIGUREDRESOLVERSYSTEMTYPE	fromClassloaderResource(String path) Configures this ResolverSystem from the result of ClassLoader.getResource(String) using the current Thread.getContextClassLoader()
CONFIGUREDRESOLVERSYSTEMTYPE	fromClassloaderResource(String path, ClassLoader loader) Configures this ResolverSystem from the result of ClassLoader.getResource(String) using the specified ClassLoader
CONFIGUREDRESOLVERSYSTEMTYPE	fromFile(File file) Configures this ResolverSystem from the specified file
CONFIGUREDRESOLVERSYSTEMTYPE	fromFile(String pathToFile) Configures this ResolverSystem from the file at the specified path

Method Detail

fromFile

CONFIGUREDRESOLVERSYSTEMTYPE fromFile(File file)
                               throws IllegalArgumentException,
                                      InvalidConfigurationFileException

Configures this ResolverSystem from the specified file

Parameters:

file - The file the ResolverSystem should be configured from

Returns:

This configured ResolverSystem

Throws:

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

InvalidConfigurationFileException - If the file is not in correct format

fromFile

CONFIGUREDRESOLVERSYSTEMTYPE fromFile(String pathToFile)
                               throws IllegalArgumentException,
                                      InvalidConfigurationFileException

Configures this ResolverSystem from the file at the specified path

Parameters:

pathToFile - Path to the file the ResolverSystem should be configured from

Returns:

This configured ResolverSystem

Throws:

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

InvalidConfigurationFileException - If the file is not in correct format

fromClassloaderResource

CONFIGUREDRESOLVERSYSTEMTYPE fromClassloaderResource(String path)
                                              throws IllegalArgumentException,
                                                     InvalidConfigurationFileException

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

Parameters:

path - Path to the classloader resource

Returns:

This configured ResolverSystem

Throws:

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

InvalidConfigurationFileException - If the file is not in correct format

fromClassloaderResource

CONFIGUREDRESOLVERSYSTEMTYPE fromClassloaderResource(String path,
                                                     ClassLoader loader)
                                              throws IllegalArgumentException,
                                                     InvalidConfigurationFileException

Configures this ResolverSystem from the result of ClassLoader.getResource(String) using the specified ClassLoader

Parameters:

path - Path to the classloader resource

loader - The classloader

Returns:

This configured ResolverSystem

Throws:

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

InvalidConfigurationFileException - If the file is not in correct format