Package dagger.spi.model
Interface BindingGraphPlugin
-
public interface BindingGraphPluginA pluggable visitor forBindingGraph.Note: This is still experimental and will change.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default voidinit(DaggerProcessingEnv processingEnv, java.util.Map<java.lang.String,java.lang.String> options)Initializes this plugin with aDaggerProcessingEnv.default voidonPluginEnd()Perform any extra work after the plugin finished all its visiting.default java.lang.StringpluginName()A distinguishing name of the plugin that will be used in diagnostics printed to the messager.default java.util.Set<java.lang.String>supportedOptions()Returns the annotation-processing options that this plugin uses to configure behavior.voidvisitGraph(BindingGraph bindingGraph, DiagnosticReporter diagnosticReporter)Called once for each valid root binding graph encountered by the Dagger processor.
-
-
-
Method Detail
-
visitGraph
void visitGraph(BindingGraph bindingGraph, DiagnosticReporter diagnosticReporter)
Called once for each valid root binding graph encountered by the Dagger processor. May report diagnostics usingdiagnosticReporter.
-
init
default void init(DaggerProcessingEnv processingEnv, java.util.Map<java.lang.String,java.lang.String> options)
Initializes this plugin with aDaggerProcessingEnv.This will be called once per instance of this plugin, before any graph is visited.
-
supportedOptions
default java.util.Set<java.lang.String> supportedOptions()
Returns the annotation-processing options that this plugin uses to configure behavior.- See Also:
Processor.getSupportedOptions()
-
pluginName
default java.lang.String pluginName()
A distinguishing name of the plugin that will be used in diagnostics printed to the messager. By default, the fully qualified name of the plugin is used.
-
onPluginEnd
default void onPluginEnd()
Perform any extra work after the plugin finished all its visiting. This will be called once per instance of this plugin, after all graphs were visited
-
-