SoftServiceLoader (GORM for MongoDB

org.grails.datastore.mapping.services.SoftServiceLoader

All Implemented Interfaces and Traits:

java.lang.Iterable
```
public final class SoftServiceLoader<S>
extends java.lang.Object
implements java.lang.Iterable
```
Variation of java.util.ServiceLoader that allows soft loading and conditional loading of META-INF/services classes.

Type Parameters:
S - The service type
Authors:
Graeme Rocher
Since:
1.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`private class`	`SoftServiceLoader.ServiceLoaderIterator`	A service loader iterator implementation.

Field Summary

Fields
Modifiers	Name	Description
`private static boolean`	`ENABLE_CLASS_LOADER_LOGGING`
`static java.lang.String`	`META_INF_SERVICES`
`static java.lang.String`	`PROPERTY_GRAILS_CLASSLOADER_LOGGING`
`static org.slf4j.Logger`	`REFLECTION_LOGGER`
`private java.lang.ClassLoader`	`classLoader`
`private java.util.function.Predicate<java.lang.String>`	`condition`
`java.util.Iterator<ServiceDefinition<S>>`	`loaded`
`private java.util.Map<java.lang.String, ServiceDefinition<S>>`	`loadedServices`
`private java.lang.Class<S>`	`serviceType`
`private java.util.Iterator<ServiceDefinition<S>>`	`unloadedServices`

Constructor Summary

Constructors
Constructor and description
`private SoftServiceLoader (java.lang.Class<S> serviceType, java.lang.ClassLoader classLoader)`
`private SoftServiceLoader (java.lang.Class<S> serviceType, java.lang.ClassLoader classLoader, java.util.function.Predicate<java.lang.String> condition)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public java.util.Optional<ServiceDefinition<S>>`	`first()` Returns: Return the first such instance
	`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
	`public static org.slf4j.Logger`	`getLogger(java.lang.Class type)` Special case `getLogger` method that should be used by classes that are used in the annotation processor.
	`public boolean`	`hasNext()`
	`public java.util.Iterator<ServiceDefinition<S>>`	`iterator()` Returns: The iterator
`<S>`	`public static SoftServiceLoader<S>`	`load(java.lang.Class<S> service)` Creates a new SoftServiceLoader using the thread context loader by default.
`<S>`	`public static SoftServiceLoader<S>`	`load(java.lang.Class<S> service, java.lang.ClassLoader loader)` Creates a new SoftServiceLoader using the given type and class loader.
`<S>`	`public static 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)` Parameters: `name` - The name
	`public ServiceDefinition<S>`	`next()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - private static final boolean ENABLE_CLASS_LOADER_LOGGING
  - public static final java.lang.String META_INF_SERVICES
  - public static final java.lang.String PROPERTY_GRAILS_CLASSLOADER_LOGGING
  - public static final org.slf4j.Logger REFLECTION_LOGGER
  - private final java.lang.ClassLoader classLoader
  - private final java.util.function.Predicate<java.lang.String> condition
  - java.util.Iterator<ServiceDefinition<S>> loaded
  - private final java.util.Map<java.lang.String, ServiceDefinition<S>> loadedServices
  - private final java.lang.Class<S> serviceType
  - private final java.util.Iterator<ServiceDefinition<S>> unloadedServices
- Constructor Detail
  - private SoftServiceLoader(java.lang.Class<S> serviceType, java.lang.ClassLoader classLoader)
  - private SoftServiceLoader(java.lang.Class<S> serviceType, java.lang.ClassLoader classLoader, java.util.function.Predicate<java.lang.String> condition)
- Method Detail
  - public java.util.Optional<ServiceDefinition<S>> first()
    
    Returns:
    Return the first such instance
  - 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
  - public static org.slf4j.Logger getLogger(java.lang.Class type)
    
    Special case getLogger method that should be used by classes that are used in the annotation processor.
    Parameters:
    type - The type
    Returns:
    The logger
  - @java.lang.Override public boolean hasNext()
  - @java.lang.Override public java.util.Iterator<ServiceDefinition<S>> iterator()
    
    Returns:
    The iterator
  - <S> public static SoftServiceLoader<S> load(java.lang.Class<S> service)
    
    Creates a new SoftServiceLoader using the thread context loader by default.
    Parameters:
    service - The service type
    Type Parameters:
    S - The service generic type
    Returns:
    A new service loader
  - <S> public static SoftServiceLoader<S> load(java.lang.Class<S> service, java.lang.ClassLoader loader)
    
    Creates a new SoftServiceLoader using the given type and class loader.
    Parameters:
    service - The service type
    loader - The class loader
    Type Parameters:
    S - The service generic type
    Returns:
    A new service loader
  - <S> public static 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.
    Parameters:
    service - The service type
    loader - The class loader to use
    condition - A java.util.function.Predicate to use to conditionally load the service. The predicate is passed the service class name
    Type Parameters:
    S - The service generic type
    Returns:
    A new service loader
  - @java.lang.SuppressWarnings("unchecked") 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
  - @java.lang.Override public ServiceDefinition<S> next()

| Detail:
Field
Constructor
Method

Groovy Documentation

[Java] Class SoftServiceLoader<S>

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

private static final boolean ENABLE_CLASS_LOADER_LOGGING

public static final java.lang.String META_INF_SERVICES

public static final java.lang.String PROPERTY_GRAILS_CLASSLOADER_LOGGING

public static final org.slf4j.Logger REFLECTION_LOGGER

private final java.lang.ClassLoader classLoader

private final java.util.function.Predicate<java.lang.String> condition

java.util.Iterator<ServiceDefinition<S>> loaded

private final java.util.Map<java.lang.String, ServiceDefinition<S>> loadedServices

private final java.lang.Class<S> serviceType

private final java.util.Iterator<ServiceDefinition<S>> unloadedServices

Constructor Detail

private SoftServiceLoader(java.lang.Class<S> serviceType, java.lang.ClassLoader classLoader)

private SoftServiceLoader(java.lang.Class<S> serviceType, java.lang.ClassLoader classLoader, java.util.function.Predicate<java.lang.String> condition)

Method Detail

public java.util.Optional<ServiceDefinition<S>> first()

public java.util.Optional<ServiceDefinition<S>> firstOr(java.lang.String alternative, java.lang.ClassLoader classLoader)

public static org.slf4j.Logger getLogger(java.lang.Class type)

@java.lang.Override public boolean hasNext()

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

<S> public static SoftServiceLoader<S> load(java.lang.Class<S> service)

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

<S> public static SoftServiceLoader<S> load(java.lang.Class<S> service, java.lang.ClassLoader loader, java.util.function.Predicate<java.lang.String> condition)

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

@java.lang.Override public ServiceDefinition<S> next()