Package dagger.spi.model

Class DiagnosticReporter

java.lang.Object

dagger.spi.model.DiagnosticReporter

public abstract class DiagnosticReporter
extends Object

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

Note: This API is still experimental and will change.

Constructor Summary

Constructors

Constructor	Description
DiagnosticReporter()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

DiagnosticReporter

public DiagnosticReporter()

Method Details

reportComponent

public abstract void reportComponent(Diagnostic.Kind diagnosticKind,
 BindingGraph.ComponentNode componentNode,
 String message)

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

reportComponent

@FormatMethod
public final void reportComponent(Diagnostic.Kind diagnosticKind,
 BindingGraph.ComponentNode componentNode,
 String messageFormat,
 Object firstArg,
 Object... moreArgs)

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

reportBinding

public abstract void reportBinding(Diagnostic.Kind diagnosticKind,
 BindingGraph.MaybeBinding binding,
 String message)

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

reportBinding

@FormatMethod
public final void reportBinding(Diagnostic.Kind diagnosticKind,
 BindingGraph.MaybeBinding binding,
 String messageFormat,
 Object firstArg,
 Object... moreArgs)

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

reportDependency

public abstract void reportDependency(Diagnostic.Kind diagnosticKind,
 BindingGraph.DependencyEdge dependencyEdge,
 String message)

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

reportDependency

@FormatMethod
public final void reportDependency(Diagnostic.Kind diagnosticKind,
 BindingGraph.DependencyEdge dependencyEdge,
 String messageFormat,
 Object firstArg,
 Object... moreArgs)

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

reportSubcomponentFactoryMethod

public abstract void reportSubcomponentFactoryMethod(Diagnostic.Kind diagnosticKind,
 BindingGraph.ChildFactoryMethodEdge childFactoryMethodEdge,
 String message)

Reports a diagnostic for a subcomponent factory method.

reportSubcomponentFactoryMethod

@FormatMethod
public final void reportSubcomponentFactoryMethod(Diagnostic.Kind diagnosticKind,
 BindingGraph.ChildFactoryMethodEdge childFactoryMethodEdge,
 String messageFormat,
 Object firstArg,
 Object... moreArgs)

Reports a diagnostic for a subcomponent factory method.