View Javadoc

1   /*
2    * Grapht, an open source dependency injector.
3    * Copyright 2014-2015 various contributors (see CONTRIBUTORS.txt)
4    * Copyright 2010-2014 Regents of the University of Minnesota
5    *
6    * This program is free software; you can redistribute it and/or modify
7    * it under the terms of the GNU Lesser General Public License as
8    * published by the Free Software Foundation; either version 2.1 of the
9    * License, or (at your option) any later version.
10   *
11   * This program is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
13   * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
14   * details.
15   *
16   * You should have received a copy of the GNU General Public License along with
17   * this program; if not, write to the Free Software Foundation, Inc., 51
18   * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19   */
20  package org.grouplens.grapht.solver;
21  
22  import org.grouplens.grapht.ResolutionException;
23  import org.grouplens.grapht.reflect.Desire;
24  
25  /**
26   * Thrown by when a cyclic dependency is detected and could not be broken or
27   * bypassed by the solver.
28   * 
29   * @author <a href="http://grouplens.org">GroupLens Research</a>
30   */
31  public class CyclicDependencyException extends ResolutionException {
32      private static final long serialVersionUID = 1L;
33  
34      private final Desire desire;
35      
36      public CyclicDependencyException(Desire desire, String msg) {
37          super(msg);
38          this.desire = desire;
39      }
40      
41      /**
42       * @return The current desire that triggered the cycle detection
43       */
44      public Desire getDesire() {
45          return desire;
46      }
47      
48      @Override
49      public String getMessage() {
50          return new StringBuilder("Unable to satisfy desire: ")
51              .append(format(desire.getInjectionPoint()))
52              .append('\n')
53              .append("Reason: ")
54              .append(super.getMessage())
55              .toString();
56      }
57  }