org.jboss.shrinkwrap.resolver.spi.loader

Interface ServiceLoader

All Known Implementing Classes:

ServiceRegistry, SpiServiceLoader

public interface ServiceLoader

ServiceLoader allows to load services available on classpath implementing given service interface. All service are required to have a non-argument public constructor. All ServiceLoader are required to handle registration of services implemented as Enums. See SpiServiceLoader for default implementation.

Author:

Karel Piwko

Method Summary

Modifier and Type	Method and Description
<T> Collection<T>	all(Class<T> serviceClass) Loads all registered services for given serviceClass.
<T> T	onlyOne(Class<T> serviceClass) Loads a registered service for given serviceClass.
<T> T	onlyOne(Class<T> serviceClass, Class<? extends T> defaultImplementationClass) Loads a registered service for given serviceClass.

Method Detail

all

<T> Collection<T> all(Class<T> serviceClass)
               throws IllegalArgumentException

Loads all registered services for given serviceClass.

Parameters:

serviceClass - The service class.

Returns:

Collection of loaded services.

Throws:

IllegalArgumentException - If serviceClass is null.

onlyOne

<T> T onlyOne(Class<T> serviceClass)
       throws IllegalArgumentException,
              IllegalStateException

Loads a registered service for given serviceClass.

Parameters:

serviceClass - The service class.

Returns:

The loaded service.

Throws:

IllegalArgumentException - If serviceClass is null.

IllegalStateException - If more than a single service is registered.

onlyOne

<T> T onlyOne(Class<T> serviceClass,
              Class<? extends T> defaultImplementationClass)
       throws IllegalArgumentException,
              IllegalStateException

Loads a registered service for given serviceClass. Reverts to the defaultImplementationClass if no other service is registered. If defaultImplemenationClass is registered as well, it simply ignores it during resolution.

Parameters:

serviceClass - The service class.

defaultImplementationClass - The default implementation class.

Returns:

The loaded service.

Throws:

IllegalArgumentException - If either serviceClass or defaultImplementationClass is null

IllegalStateException - If more than a single service is registered