com.phloc.commons.lang

Class ServiceLoaderUtils

java.lang.Object

com.phloc.commons.lang.ServiceLoaderUtils

@Immutable
public final class ServiceLoaderUtils
extends Object

ServiceLoader helper class.

Author:

boris, Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
static <T> List<T>	getAllSPIImplementations(Class<T> aSPIClass) Uses the ServiceLoader to load all SPI implementations of the passed class
static <T> List<T>	getAllSPIImplementations(Class<T> aSPIClass, ClassLoader aClassLoader) Uses the ServiceLoader to load all SPI implementations of the passed class
static <T> List<T>	getAllSPIImplementations(Class<T> aSPIClass, ClassLoader aClassLoader, org.slf4j.Logger aLogger) Uses the ServiceLoader to load all SPI implementations of the passed class
static <T> List<T>	getAllSPIImplementations(Class<T> aSPIClass, org.slf4j.Logger aLogger) Uses the ServiceLoader to load all SPI implementations of the passed class
static <T> T	getFirstSPIImplementation(Class<T> aSPIClass) Uses the ServiceLoader to load all SPI implementations of the passed class and return only the first instance.
static <T> T	getFirstSPIImplementation(Class<T> aSPIClass, ClassLoader aClassLoader) Uses the ServiceLoader to load all SPI implementations of the passed class and return only the first instance.
static <T> T	getFirstSPIImplementation(Class<T> aSPIClass, ClassLoader aClassLoader, org.slf4j.Logger aLogger) Uses the ServiceLoader to load all SPI implementations of the passed class and return only the first instance.
static <T> T	getFirstSPIImplementation(Class<T> aSPIClass, org.slf4j.Logger aLogger) Uses the ServiceLoader to load all SPI implementations of the passed class and return only the first instance.

Methods inherited from class java.lang.Object

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

Method Detail

getAllSPIImplementations

@Nonnull
@ReturnsMutableCopy
public static <T> List<T> getAllSPIImplementations(@Nonnull
                                                              Class<T> aSPIClass)

Uses the ServiceLoader to load all SPI implementations of the passed class

Parameters:

aSPIClass - The SPI interface class. May not be null.

Returns:

A list of all currently available plugins

getAllSPIImplementations

@Nonnull
@ReturnsMutableCopy
public static <T> List<T> getAllSPIImplementations(@Nonnull
                                                              Class<T> aSPIClass,
                                                              @Nonnull
                                                              ClassLoader aClassLoader)

Uses the ServiceLoader to load all SPI implementations of the passed class

Parameters:

aSPIClass - The SPI interface class. May not be null.

aClassLoader - The class loader to use for the SPI loader. May not be null.

Returns:

A list of all currently available plugins

getAllSPIImplementations

@Nonnull
@ReturnsMutableCopy
public static <T> List<T> getAllSPIImplementations(@Nonnull
                                                              Class<T> aSPIClass,
                                                              @Nullable
                                                              org.slf4j.Logger aLogger)

Uses the ServiceLoader to load all SPI implementations of the passed class

Parameters:

aSPIClass - The SPI interface class. May not be null.

aLogger - An optional logger to use. May be null.

Returns:

A list of all currently available plugins

getAllSPIImplementations

@Nonnull
@ReturnsMutableCopy
public static <T> List<T> getAllSPIImplementations(@Nonnull
                                                              Class<T> aSPIClass,
                                                              @Nonnull
                                                              ClassLoader aClassLoader,
                                                              @Nullable
                                                              org.slf4j.Logger aLogger)

Uses the ServiceLoader to load all SPI implementations of the passed class

Parameters:

aSPIClass - The SPI interface class. May not be null.

aClassLoader - The class loader to use for the SPI loader. May not be null.

aLogger - An optional logger to use. May be null.

Returns:

A collection of all currently available plugins. Never null.

getFirstSPIImplementation

@Nullable
public static <T> T getFirstSPIImplementation(@Nonnull
                                       Class<T> aSPIClass)

Uses the ServiceLoader to load all SPI implementations of the passed class and return only the first instance.

Parameters:

aSPIClass - The SPI interface class. May not be null.

Returns:

A collection of all currently available plugins. Never null.

getFirstSPIImplementation

@Nullable
public static <T> T getFirstSPIImplementation(@Nonnull
                                       Class<T> aSPIClass,
                                       @Nonnull
                                       ClassLoader aClassLoader)

Uses the ServiceLoader to load all SPI implementations of the passed class and return only the first instance.

Parameters:

aSPIClass - The SPI interface class. May not be null.

aClassLoader - The class loader to use for the SPI loader. May not be null.

Returns:

A collection of all currently available plugins. Never null.

getFirstSPIImplementation

@Nullable
public static <T> T getFirstSPIImplementation(@Nonnull
                                       Class<T> aSPIClass,
                                       @Nullable
                                       org.slf4j.Logger aLogger)

Uses the ServiceLoader to load all SPI implementations of the passed class and return only the first instance.

Parameters:

aSPIClass - The SPI interface class. May not be null.

aLogger - An optional logger to use. May be null.

Returns:

A collection of all currently available plugins. Never null.

getFirstSPIImplementation

@Nullable
public static <T> T getFirstSPIImplementation(@Nonnull
                                       Class<T> aSPIClass,
                                       @Nonnull
                                       ClassLoader aClassLoader,
                                       @Nullable
                                       org.slf4j.Logger aLogger)

Uses the ServiceLoader to load all SPI implementations of the passed class and return only the first instance.

Parameters:

aSPIClass - The SPI interface class. May not be null.

aClassLoader - The class loader to use for the SPI loader. May not be null.

aLogger - An optional logger to use. May be null.

Returns:

A collection of all currently available plugins. Never null.