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:

java.lang.Iterable<ServiceDefinition<S>>

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

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

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	META_INF_SERVICES

Method Summary

Modifier and Type	Method and Description
java.util.Optional<ServiceDefinition<S>>	first()
java.util.Optional<ServiceDefinition<S>>	firstOr(java.lang.String alternative, java.lang.ClassLoader classLoader)
java.util.Iterator<ServiceDefinition<S>>	iterator()
static <S> SoftServiceLoader<S>	load(java.lang.Class<S> service) Creates a new SoftServiceLoader using the thread context loader by default.
static <S> SoftServiceLoader<S>	load(java.lang.Class<S> service, java.lang.ClassLoader loader) Creates a new SoftServiceLoader using the given type and class loader.
static <S> SoftServiceLoader<S>	load(java.lang.Class<S> service, java.lang.ClassLoader loader, java.util.function.Predicate<java.lang.String> condition) Creates a new SoftServiceLoader using the given type and class loader.
protected ServiceDefinition<S>	newService(java.lang.String name, java.util.Optional<java.lang.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 java.lang.String META_INF_SERVICES

See Also:

Constant Field Values

Method Detail

load

public static <S> SoftServiceLoader<S> load(java.lang.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(java.lang.Class<S> service,
                                            java.lang.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(java.lang.Class<S> service,
                                            java.lang.ClassLoader loader,
                                            java.util.function.Predicate<java.lang.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 java.util.Optional<ServiceDefinition<S>> first()

Returns:

Return the first such instance

firstOr

public java.util.Optional<ServiceDefinition<S>> firstOr(java.lang.String alternative,
                                                        java.lang.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

iterator

public java.util.Iterator<ServiceDefinition<S>> iterator()

Specified by:

iterator in interface java.lang.Iterable<ServiceDefinition<S>>

Returns:

The iterator

newService

protected ServiceDefinition<S> newService(java.lang.String name,
                                          java.util.Optional<java.lang.Class> loadedClass)

Parameters:

name - The name

loadedClass - The loaded class

Returns:

The service definition