com.netflix.governator.guice

Class Grapher

java.lang.Object

com.netflix.governator.guice.Grapher

public class Grapher
extends java.lang.Object

An object that can generate a graph showing a Guice Dependency Injection graph.

See Also:

GraphViz, Guice Grapher, XDot, an interactive viewer for Dot files

Constructor Summary

Constructors

Constructor and Description
Grapher(com.google.inject.Injector injector) Creates a new Grapher.
Grapher(com.google.inject.Injector injector, java.lang.Class<?>... classes) Creates a new Grapher.
Grapher(com.google.inject.Injector injector, com.google.inject.Key<?>... keys) Creates a new Grapher.
Grapher(com.google.inject.Injector injector, java.lang.String... packages) Creates a new Grapher.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	graph() Returns a String containing the "Dot" graph definition.
java.lang.String	toFile() Writes the "Dot" graph to a new temp file.
void	toFile(java.io.File file) Writes the "Dot" graph to a given file.

Methods inherited from class java.lang.Object

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

Constructor Detail

Grapher

@Inject
public Grapher(com.google.inject.Injector injector)

Creates a new Grapher.

Parameters:

injector - the Injector whose dependency graph will be generated

Grapher

public Grapher(com.google.inject.Injector injector,
       com.google.inject.Key<?>... keys)

Creates a new Grapher.

Parameters:

injector - the Injector whose dependency graph will be generated

keys - Keys for the roots of the graph

Grapher

public Grapher(com.google.inject.Injector injector,
       java.lang.Class<?>... classes)

Creates a new Grapher.

Parameters:

injector - the Injector whose dependency graph will be generated

classes - Classes for the roots of the graph

Grapher

public Grapher(com.google.inject.Injector injector,
       java.lang.String... packages)

Creates a new Grapher.

Parameters:

injector - the Injector whose dependency graph will be generated

packages - names of Packages for the roots of the graph

Method Detail

toFile

public java.lang.String toFile()
                        throws java.lang.Exception

Writes the "Dot" graph to a new temp file.

Returns:

the name of the newly created file

Throws:

java.lang.Exception

toFile

public void toFile(java.io.File file)
            throws java.lang.Exception

Writes the "Dot" graph to a given file.

Parameters:

file - file to write to

Throws:

java.lang.Exception

graph

public java.lang.String graph()
                       throws java.lang.Exception

Returns a String containing the "Dot" graph definition.

Returns:

the "Dot" graph definition

Throws:

java.lang.Exception