com.salesforce.omakase

Interface PluginRegistry

public interface PluginRegistry

Registry of Plugins.

This allows you to require plugins as dependencies and also retrieve registered plugin instances. Note that only one instance of a specific plugin can be registered.

Method Summary

Modifier and Type	Method and Description
void	register(Iterable<? extends Plugin> plugins) Registers Plugin instances to this PluginRegistry.
void	register(Plugin plugin) Registers a single Plugin.
<T extends Plugin> T	require(Class<T> klass) Specifies that a particular plugin is required as a dependency.
<T extends Plugin> T	require(Class<T> klass, Supplier<T> supplier) Same as require(Class), except this should be used for custom (non-library-provided) plugins.
<T extends Plugin> Optional<T>	retrieve(Class<T> klass) Retrieves the instance of the given Plugin type.

Method Detail

register

void register(Iterable<? extends Plugin> plugins)

Registers Plugin instances to this PluginRegistry.

Only one instance of a specific Plugin can be registered to a single PluginRegistry. This is to make require(Class) and retrieve(Class) work in a simple way. Plugins should be coded with this in mind.

Parameters:

plugins - The Plugin(s) to register.

register

void register(Plugin plugin)

Registers a single Plugin.

Only one instance of a specific Plugin can be registered to a single PluginRegistry. This is to make require(Class) and retrieve(Class) work in a simple way. Plugins should be coded with this in mind.

Parameters:

plugin - The plugin to register.

require

<T extends Plugin> T require(Class<T> klass)

Specifies that a particular plugin is required as a dependency.

If the plugin is already registered then the registered instance will simply be returned. If the plugin is not registered then a new instance will be created, registered, then returned.

This method is only for library-provided plugins. To require a custom plugin, use require(Class, Supplier) instead.

This method is usually used within the DependentPlugin#dependencies(PluginRegistry) method.

Examples:

  registry.require(SyntaxTree.class)
  registry.require(UrlPlugin.class)
 

Type Parameters:

T - Type of the plugin.

Parameters:

klass - The plugin class.

Returns:

An instance of the plugin.

require

<T extends Plugin> T require(Class<T> klass,
                             Supplier<T> supplier)

Same as require(Class), except this should be used for custom (non-library-provided) plugins.

The Supplier is used to get an instance if one is not already registered. This method is usually used within the DependentPlugin#dependencies(PluginRegistry) method.

Type Parameters:

T - Type of the plugin.

Parameters:

klass - The plugin class.

supplier - Supplies an instance of the plugin.

Returns:

An instance of the plugin.

retrieve

<T extends Plugin> Optional<T> retrieve(Class<T> klass)

Retrieves the instance of the given Plugin type. This is normally used by Plugins to access another Plugin instance that they are dependent on.

Type Parameters:

T - Get the instance of this Plugin type.

Parameters:

klass - Class of the plugin to retrieve.

Returns:

The instance, or an empty Optional if no instance of the Plugin was registered.