• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2008 Google Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.google.inject.grapher;
18 
19 import com.google.inject.Injector;
20 import com.google.inject.Key;
21 import java.io.IOException;
22 import java.util.Set;
23 
24 /**
25  * Guice injector grapher. Renders the guice dependency graph for an injector. It can render the
26  * whole dependency graph or just transitive dependencies of a given set of nodes.
27  *
28  * @author phopkins@gmail.com (Pete Hopkins)
29  * @since 4.0 (since 2.0 as a concrete class with a different API)
30  */
31 public interface InjectorGrapher {
32 
33   /** Graphs the guice dependency graph for the given injector using default starting keys. */
graph(Injector injector)34   void graph(Injector injector) throws IOException;
35 
36   /**
37    * Graphs the guice dependency graph for the given injector using the given starting keys and
38    * their transitive dependencies.
39    */
graph(Injector injector, Set<Key<?>> root)40   void graph(Injector injector, Set<Key<?>> root) throws IOException;
41 }
42