io.micronaut.core.io.service

Class SoftServiceLoader<S>

java.lang.Object

io.micronaut.core.io.service.SoftServiceLoader<S>

Type Parameters:

S - The service type

All Implemented Interfaces:

Iterable<ServiceDefinition<S>>

public final class SoftServiceLoader<S>
extends Object
implements Iterable<ServiceDefinition<S>>

Variation of ServiceLoader that allows soft loading and conditional loading of META-INF/services classes.

Since:

1.0

Author:

Graeme Rocher

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoftServiceLoader.Optimizations Static optimizations for service loaders.
static interface	SoftServiceLoader.ServiceCollector<S> Service collector for loading services of the given type.
static class	SoftServiceLoader.StaticDefinition<S> A ServiceDefinition implementation that uses a MethodHandles.Lookup object to find a public constructor.
static interface	SoftServiceLoader.StaticServiceLoader<S> Service loader that uses SoftServiceLoader.StaticDefinition.

Field Summary

Fields

Modifier and Type	Field and Description
static String	META_INF_SERVICES

Method Summary

Modifier and Type	Method and Description
void	collectAll(Collection<S> values) Collects all initialized instances.
void	collectAll(Collection<S> values, Predicate<S> predicate) Collects all initialized instances.
Optional<ServiceDefinition<S>>	first()
Optional<ServiceDefinition<S>>	firstOr(String alternative, ClassLoader classLoader)
Iterator<ServiceDefinition<S>>	iterator()
static <S> SoftServiceLoader<S>	load(Class<S> service) Creates a new SoftServiceLoader using the thread context loader by default.
static <S> SoftServiceLoader<S>	load(Class<S> service, ClassLoader loader) Creates a new SoftServiceLoader using the given type and class loader.
static <S> SoftServiceLoader<S>	load(Class<S> service, ClassLoader loader, Predicate<String> condition) Creates a new SoftServiceLoader using the given type and class loader.
static <S> SoftServiceLoader.ServiceCollector<S>	newCollector(String serviceName, Predicate<String> lineCondition, ClassLoader classLoader, Function<String,S> transformer)
protected ServiceDefinition<S>	newService(String name, Optional<Class> loadedClass)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

META_INF_SERVICES

public static final String META_INF_SERVICES

See Also:

Constant Field Values

Method Detail

load

public static <S> SoftServiceLoader<S> load(Class<S> service)

Creates a new SoftServiceLoader using the thread context loader by default.

Type Parameters:

S - The service generic type

Parameters:

service - The service type

Returns:

A new service loader

load

public static <S> SoftServiceLoader<S> load(Class<S> service,
                                            ClassLoader loader)

Creates a new SoftServiceLoader using the given type and class loader.

Type Parameters:

S - The service generic type

Parameters:

service - The service type

loader - The class loader

Returns:

A new service loader

load

public static <S> SoftServiceLoader<S> load(Class<S> service,
                                            ClassLoader loader,
                                            Predicate<String> condition)

Creates a new SoftServiceLoader using the given type and class loader.

Type Parameters:

S - The service generic type

Parameters:

service - The service type

loader - The class loader to use

condition - A Predicate to use to conditionally load the service. The predicate is passed the service class name

Returns:

A new service loader

first

public Optional<ServiceDefinition<S>> first()

Returns:

Return the first such instance

firstOr

public Optional<ServiceDefinition<S>> firstOr(String alternative,
                                              ClassLoader classLoader)

Parameters:

alternative - An alternative type to use if the this type is not present

classLoader - The classloader

Returns:

Return the first such instance

collectAll

public void collectAll(@NonNull
                       Collection<S> values,
                       @Nullable
                       Predicate<S> predicate)

Collects all initialized instances.

Parameters:

values - The collection to be populated.

predicate - The predicated to filter the instances or null if not needed.

collectAll

public void collectAll(@NonNull
                       Collection<S> values)

Collects all initialized instances.

Parameters:

values - The collection to be populated.

iterator

public Iterator<ServiceDefinition<S>> iterator()

Specified by:

iterator in interface Iterable<ServiceDefinition<S>>

Returns:

The iterator

newService

protected ServiceDefinition<S> newService(String name,
                                          Optional<Class> loadedClass)

Parameters:

name - The name

loadedClass - The loaded class

Returns:

The service definition

newCollector

public static <S> SoftServiceLoader.ServiceCollector<S> newCollector(String serviceName,
                                                                     Predicate<String> lineCondition,
                                                                     ClassLoader classLoader,
                                                                     Function<String,S> transformer)