org.ehcache.core.spi.service

Interface ServiceFactory<T extends Service>

public interface ServiceFactory<T extends Service>

A factory abstraction that can create Service instances.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ServiceFactory.RequiresConfiguration

Method Summary

Modifier and Type	Method and Description
T	create(ServiceCreationConfiguration<T,?> configuration) Creates an instance of the service using the passed in ServiceCreationConfiguration.
java.lang.Class<? extends T>	getServiceType() Queries a ServiceFactory to know which concrete Service type it produces.
default boolean	isMandatory() Returns true if this factory's services are mandatory in all environments.
default int	rank() Returns an optional ranking integer is used to choose a service factory when multiple factories are available for the same service type.

Method Detail

isMandatory

default boolean isMandatory()

Returns true if this factory's services are mandatory in all environments.

Returns:

true if this factory's services are mandatory

rank

default int rank()

Returns an optional ranking integer is used to choose a service factory when multiple factories are available for the same service type. Higher ranking value service factories are preferred.

Returns:

a factory ranking value

create

T create(ServiceCreationConfiguration<T,?> configuration)

Creates an instance of the service using the passed in ServiceCreationConfiguration.

Note that a null configuration may be supported or even required by a service implementation.

Parameters:

configuration - the creation configuration, can be null for some services

Returns:

the new service, not started

getServiceType

java.lang.Class<? extends T> getServiceType()

Queries a ServiceFactory to know which concrete Service type it produces.

Returns:

the concrete class of the produced service.