com.salesforce.omakase.plugin.core

Class AutoRefine

java.lang.Object

com.salesforce.omakase.plugin.core.AutoRefine

All Implemented Interfaces:

DependentPlugin, Plugin

public final class AutoRefine
extends Object
implements DependentPlugin

Automatically refines Refinable types.

This plugin should be added to the parse operation as the easiest to way ensure refinement of certain or all Refinable types is performed. It should be added last so that other custom refiners will not be preempted.

Refinement ensures that subscription methods to leaf syntax units (such as UrlFunctionValue or ClassSelector) are delivered. Such units will not be delivered if the parent selector or declaration was not refined. For more information on refinement see the main readme file.

Example:

     Omakase.use(AutoRefine.everything()).use(...).process();
     Omakase.use(AutoRefine.only(Match.FUNCTIONS).use(...).process();
 

If including this plugin as a dependency then it's preferred to refine everything, otherwise consider requiring a more specific refiner plugin such as DeclarationPlugin instead.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AutoRefine.Match Types of Refinables to auto-refine.

Constructor Summary

Constructors

Constructor and Description
AutoRefine() Creates a new AutoRefine matching all Refinables.
AutoRefine(EnumSet<AutoRefine.Match> matches) Creates a new AutoRefine matching the specified types.

Method Summary

Modifier and Type	Method and Description
void	dependencies(PluginRegistry registry) Registers plugin dependencies.
static AutoRefine	everything() Creates an AutoRefine that matches everything.
static AutoRefine	only(AutoRefine.Match match, AutoRefine.Match... matches) Creates an AutoRefine that matches the specified types.

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoRefine

public AutoRefine()

Creates a new AutoRefine matching all Refinables.

AutoRefine

public AutoRefine(EnumSet<AutoRefine.Match> matches)

Creates a new AutoRefine matching the specified types.

Parameters:

matches - Types of Refinables to auto-refine.

Method Detail

dependencies

public void dependencies(PluginRegistry registry)

Description copied from interface: DependentPlugin

Registers plugin dependencies.

Any plugins you add to the registry in this method will be ordered before this plugin itself.

Keep in mind that only one instance of a plugin can be added in a single parsing operation. You can use PluginRegistry.require(Class), PluginRegistry.require(Class, Supplier) and PluginRegistry.retrieve(Class) to assist in scenarios where a plugin instance may have already been added.

Dependencies to include can range from refinement dependencies such as SelectorPlugin and MediaPlugin to other custom plugins.

Specified by:

dependencies in interface DependentPlugin

Parameters:

registry - The PluginRegistry instance.

See Also:

PluginRegistry.require(Class), PluginRegistry.require(Class, Supplier), PluginRegistry.retrieve(Class)

everything

public static AutoRefine everything()

Creates an AutoRefine that matches everything.

Returns:

The new AutoRefine instance.

only

public static AutoRefine only(AutoRefine.Match match,
                              AutoRefine.Match... matches)

Creates an AutoRefine that matches the specified types.

Parameters:

match - The first match.

matches - Optional additional matches.

Returns:

The new AutoRefine instance.