io.quarkus.deployment.builditem.nativeimage

Class ServiceProviderBuildItem

java.lang.Object

io.quarkus.builder.item.BuildItem

io.quarkus.builder.item.MultiBuildItem

io.quarkus.deployment.builditem.nativeimage.ServiceProviderBuildItem

public final class ServiceProviderBuildItem
extends MultiBuildItem

Represents a Service Provider registration. When processed, it embeds the service interface descriptor (META-INF/services/...) and allow reflection (instantiation only) on a set of provider classes.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SPI_ROOT

Constructor Summary

Constructors

Constructor and Description
ServiceProviderBuildItem(String serviceInterfaceClassName, List<String> providers) Registers the specified service interface descriptor to be embedded and allow reflection (instantiation only) of the specified provider classes.
ServiceProviderBuildItem(String serviceInterfaceClassName, String... providerClassNames) Registers the specified service interface descriptor to be embedded and allow reflection (instantiation only) of the specified provider classes.

Method Summary

Modifier and Type	Method and Description
List<String>	providers()
String	serviceDescriptorFile()

Methods inherited from class java.lang.Object

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

Field Detail

SPI_ROOT

public static final String SPI_ROOT

See Also:

Constant Field Values

Constructor Detail

ServiceProviderBuildItem

public ServiceProviderBuildItem(String serviceInterfaceClassName,
                                String... providerClassNames)

Registers the specified service interface descriptor to be embedded and allow reflection (instantiation only) of the specified provider classes. Note that the service interface descriptor file has to exist and match the list of specified provider class names.

Parameters:

serviceInterfaceClassName - the interface whose service interface descriptor file we want to embed

providerClassNames - the list of provider class names that must already be mentioned in the file

ServiceProviderBuildItem

public ServiceProviderBuildItem(String serviceInterfaceClassName,
                                List<String> providers)

Registers the specified service interface descriptor to be embedded and allow reflection (instantiation only) of the specified provider classes. Note that the service interface descriptor file has to exist and match the list of specified provider class names.

Parameters:

serviceInterfaceClassName - the interface whose service interface descriptor file we want to embed

providers - the list of provider class names that must already be mentioned in the file

Method Detail

providers

public List<String> providers()

serviceDescriptorFile

public String serviceDescriptorFile()