APIdia Launch Partner
Top Description Inners Fields Constructors Methods
jdk.internal.module

public final Class ServicesCatalog

extends Object
Class Inheritance
Imports
java.lang.module.ModuleDescriptor, .ModuleDescriptor.Provides, java.util.Arrays, .List, .Map, .Objects, java.util.concurrent.ConcurrentHashMap, .CopyOnWriteArrayList, jdk.internal.loader.ClassLoaderValue

A services catalog. Each ClassLoader and Layer has an optional ServicesCatalog for modules that provide services.

API Note

This class will be replaced once the ServiceLoader is further specified

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
ServicesCatalog.ServiceProvider

Represents a service provider in the services catalog.

Field Summary

Modifier and TypeField and Description
private static final ClassLoaderValue<ServicesCatalog>
private final Map<String, List<ServicesCatalog.ServiceProvider>>

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public void
addProvider(Module module, Class<?> service, Class<?> impl)

Adds a provider in the given module to this services catalog.

private void
addProviders(String service, ServicesCatalog.ServiceProvider... providers)

Adds service providers for the given service type.

public static ServicesCatalog
create()

Creates a ServicesCatalog that supports concurrent registration and lookup

public List<ServicesCatalog.ServiceProvider>
findServices(String service)

Returns the (possibly empty) list of service providers that implement the given service type.

public static ServicesCatalog
getServicesCatalog(ClassLoader loader)

Returns the ServicesCatalog for the given class loader, creating it if needed.

public static ServicesCatalog
getServicesCatalogOrNull(ClassLoader loader)

Returns the ServicesCatalog for the given class loader or null if there is none.

public static void
putServicesCatalog(ClassLoader loader, ServicesCatalog catalog)

Associates the given ServicesCatalog with the given class loader.

public void
register(Module module)

Registers the providers in the given module in this services catalog.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

CLVback to summary
private static final ClassLoaderValue<ServicesCatalog> CLV
mapback to summary
private final Map<String, List<ServicesCatalog.ServiceProvider>> map

Constructor Detail

ServicesCatalogback to summary
private ServicesCatalog()

Method Detail

addProviderback to summary
public void addProvider(Module module, Class<?> service, Class<?> impl)

Adds a provider in the given module to this services catalog.

API Note

This method is for use by java.lang.instrument

addProvidersback to summary
private void addProviders(String service, ServicesCatalog.ServiceProvider... providers)

Adds service providers for the given service type.

createback to summary
public static ServicesCatalog create()

Creates a ServicesCatalog that supports concurrent registration and lookup

findServicesback to summary
public List<ServicesCatalog.ServiceProvider> findServices(String service)

Returns the (possibly empty) list of service providers that implement the given service type.

getServicesCatalogback to summary
public static ServicesCatalog getServicesCatalog(ClassLoader loader)

Returns the ServicesCatalog for the given class loader, creating it if needed.

getServicesCatalogOrNullback to summary
public static ServicesCatalog getServicesCatalogOrNull(ClassLoader loader)

Returns the ServicesCatalog for the given class loader or null if there is none.

putServicesCatalogback to summary
public static void putServicesCatalog(ClassLoader loader, ServicesCatalog catalog)

Associates the given ServicesCatalog with the given class loader.

registerback to summary
public void register(Module module)

Registers the providers in the given module in this services catalog.

jdk.internal.module back to summary

public final Class ServicesCatalog.ServiceProvider

extends Object
Class Inheritance

Represents a service provider in the services catalog.

Field Summary

Modifier and TypeField and Description
private final Module
private final String

Constructor Summary

AccessConstructor and Description
public
ServiceProvider(Module module, String providerName)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object ob)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public Module
public String
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

moduleback to summary
private final Module module
providerNameback to summary
private final String providerName

Constructor Detail

ServiceProviderback to summary
public ServiceProvider(Module module, String providerName)

Method Detail

equalsback to summary
public boolean equals(Object ob)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override
moduleback to summary
public Module module()
providerNameback to summary
public String providerName()