dagger.spi.BindingGraphPlugin Maven / Gradle / Ivy
Show all versions of dagger-spi Show documentation
/*
* Copyright (C) 2017 The Dagger Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package dagger.spi;
import dagger.model.BindingGraph;
import java.util.Collections;
import java.util.Map;
import java.util.Set;
import javax.annotation.processing.Filer;
import javax.annotation.processing.Messager;
import javax.lang.model.util.Elements;
import javax.lang.model.util.Types;
/**
* A pluggable visitor for {@link BindingGraph}.
*
* Note: This is still experimental and will change.
*/
public interface BindingGraphPlugin {
/**
* Called once for each valid root binding graph encountered by the Dagger processor. May report
* diagnostics using {@code diagnosticReporter}.
*/
void visitGraph(BindingGraph bindingGraph, DiagnosticReporter diagnosticReporter);
/**
* Initializes this plugin with a {@link Filer} that it can use to write Java or other files based
* on the binding graph. This will be called once per instance of this plugin, before any graph is
* {@linkplain #visitGraph(BindingGraph, DiagnosticReporter) visited}.
*
* @see javax.annotation.processing.ProcessingEnvironment#getFiler()
*/
default void initFiler(Filer filer) {}
/**
* Initializes this plugin with a {@link Types} instance. This will be called once per instance of
* this plugin, before any graph is {@linkplain #visitGraph(BindingGraph, DiagnosticReporter)
* visited}.
*
* @see javax.annotation.processing.ProcessingEnvironment#getTypeUtils()
*/
default void initTypes(Types types) {}
/**
* Initializes this plugin with a {@link Elements} instance. This will be called once per instance
* of this plugin, before any graph is {@linkplain #visitGraph(BindingGraph, DiagnosticReporter)
* visited}.
*
* @see javax.annotation.processing.ProcessingEnvironment#getElementUtils()
*/
default void initElements(Elements elements) {}
/**
* Initializes this plugin with a filtered view of the options passed on the {@code javac}
* command-line for all keys from {@link #supportedOptions()}. This will be called once per
* instance of this plugin, before any graph is {@linkplain #visitGraph(BindingGraph,
* DiagnosticReporter) visited}.
*
* @see javax.annotation.processing.ProcessingEnvironment#getOptions()
*/
default void initOptions(Map options) {}
/**
* Returns the annotation-processing options that this plugin uses to configure behavior.
*
* @see javax.annotation.processing.Processor#getSupportedOptions()
*/
default Set supportedOptions() {
return Collections.emptySet();
}
/**
* A distinguishing name of the plugin that will be used in diagnostics printed to the {@link
* Messager}. By default, the {@linkplain Class#getCanonicalName() fully qualified name} of the
* plugin is used.
*/
default String pluginName() {
return getClass().getCanonicalName();
}
/**
* 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 {@linkplain #visitGraph(BindingGraph,
* DiagnosticReporter) visited}
*/
default void onPluginEnd() {}
}