dagger.spi

Interface DiagnosticReporter

public interface DiagnosticReporter

An object that BindingGraphPlugins can use to report diagnostics while visiting a BindingGraph.

Note: This API is still experimental and will change.

Method Summary

Modifier and Type	Method and Description
void	reportBinding(javax.tools.Diagnostic.Kind diagnosticKind, dagger.model.BindingGraph.MaybeBinding binding, java.lang.String message) Reports a diagnostic for a binding or missing binding.
void	reportBinding(javax.tools.Diagnostic.Kind diagnosticKind, dagger.model.BindingGraph.MaybeBinding binding, java.lang.String messageFormat, java.lang.Object firstArg, java.lang.Object... moreArgs) Reports a diagnostic for a binding or missing binding.
void	reportComponent(javax.tools.Diagnostic.Kind diagnosticKind, dagger.model.BindingGraph.ComponentNode componentNode, java.lang.String message) Reports a diagnostic for a component.
void	reportComponent(javax.tools.Diagnostic.Kind diagnosticKind, dagger.model.BindingGraph.ComponentNode componentNode, java.lang.String messageFormat, java.lang.Object firstArg, java.lang.Object... moreArgs) Reports a diagnostic for a component.
void	reportDependency(javax.tools.Diagnostic.Kind diagnosticKind, dagger.model.BindingGraph.DependencyEdge dependencyEdge, java.lang.String message) Reports a diagnostic for a dependency.
void	reportDependency(javax.tools.Diagnostic.Kind diagnosticKind, dagger.model.BindingGraph.DependencyEdge dependencyEdge, java.lang.String messageFormat, java.lang.Object firstArg, java.lang.Object... moreArgs) Reports a diagnostic for a dependency.
void	reportSubcomponentFactoryMethod(javax.tools.Diagnostic.Kind diagnosticKind, dagger.model.BindingGraph.ChildFactoryMethodEdge childFactoryMethodEdge, java.lang.String message) Reports a diagnostic for a subcomponent factory method.
void	reportSubcomponentFactoryMethod(javax.tools.Diagnostic.Kind diagnosticKind, dagger.model.BindingGraph.ChildFactoryMethodEdge childFactoryMethodEdge, java.lang.String messageFormat, java.lang.Object firstArg, java.lang.Object... moreArgs) Reports a diagnostic for a subcomponent factory method.

Method Detail

reportComponent

void reportComponent(javax.tools.Diagnostic.Kind diagnosticKind,
                     dagger.model.BindingGraph.ComponentNode componentNode,
                     java.lang.String message)

Reports a diagnostic for a component. For non-root components, includes information about the path from the root component.

reportComponent

@FormatMethod
void reportComponent(javax.tools.Diagnostic.Kind diagnosticKind,
                                   dagger.model.BindingGraph.ComponentNode componentNode,
                                   java.lang.String messageFormat,
                                   java.lang.Object firstArg,
                                   java.lang.Object... moreArgs)

Reports a diagnostic for a component. For non-root components, includes information about the path from the root component.

reportBinding

void reportBinding(javax.tools.Diagnostic.Kind diagnosticKind,
                   dagger.model.BindingGraph.MaybeBinding binding,
                   java.lang.String message)

Reports a diagnostic for a binding or missing binding. Includes information about how the binding is reachable from entry points.

reportBinding

@FormatMethod
void reportBinding(javax.tools.Diagnostic.Kind diagnosticKind,
                                 dagger.model.BindingGraph.MaybeBinding binding,
                                 java.lang.String messageFormat,
                                 java.lang.Object firstArg,
                                 java.lang.Object... moreArgs)

Reports a diagnostic for a binding or missing binding. Includes information about how the binding is reachable from entry points.

reportDependency

void reportDependency(javax.tools.Diagnostic.Kind diagnosticKind,
                      dagger.model.BindingGraph.DependencyEdge dependencyEdge,
                      java.lang.String message)

Reports a diagnostic for a dependency. Includes information about how the dependency is reachable from entry points.

reportDependency

@FormatMethod
void reportDependency(javax.tools.Diagnostic.Kind diagnosticKind,
                                    dagger.model.BindingGraph.DependencyEdge dependencyEdge,
                                    java.lang.String messageFormat,
                                    java.lang.Object firstArg,
                                    java.lang.Object... moreArgs)

Reports a diagnostic for a dependency. Includes information about how the dependency is reachable from entry points.

reportSubcomponentFactoryMethod

void reportSubcomponentFactoryMethod(javax.tools.Diagnostic.Kind diagnosticKind,
                                     dagger.model.BindingGraph.ChildFactoryMethodEdge childFactoryMethodEdge,
                                     java.lang.String message)

Reports a diagnostic for a subcomponent factory method.

reportSubcomponentFactoryMethod

@FormatMethod
void reportSubcomponentFactoryMethod(javax.tools.Diagnostic.Kind diagnosticKind,
                                                   dagger.model.BindingGraph.ChildFactoryMethodEdge childFactoryMethodEdge,
                                                   java.lang.String messageFormat,
                                                   java.lang.Object firstArg,
                                                   java.lang.Object... moreArgs)

Reports a diagnostic for a subcomponent factory method.