View Javadoc
1   package org.nuiton.eugene.models.extension.tagvalue;
2   
3   /*
4    * #%L
5    * EUGene :: EUGene
6    * %%
7    * Copyright (C) 2004 - 2015 CodeLutin
8    * %%
9    * This program is free software: you can redistribute it and/or modify
10   * it under the terms of the GNU Lesser General Public License as
11   * published by the Free Software Foundation, either version 3 of the
12   * License, or (at your option) any later version.
13   * 
14   * This program is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17   * GNU General Lesser Public License for more details.
18   * 
19   * You should have received a copy of the GNU General Lesser Public
20   * License along with this program.  If not, see
21   * <http://www.gnu.org/licenses/lgpl-3.0.html>.
22   * #L%
23   */
24  
25  import com.google.common.base.Joiner;
26  import org.nuiton.eugene.models.object.ObjectModelClass;
27  import org.nuiton.eugene.models.object.ObjectModelPackage;
28  
29  import java.util.LinkedHashSet;
30  import java.util.Set;
31  
32  /**
33   * When a missing tag value is detected.
34   *
35   * Created on 15/08/15.
36   *
37   * @author Tony Chemit - chemit@codelutin.com
38   * @since 3.0
39   */
40  public class MissingStereoTypeException extends RuntimeException {
41  
42      private static final long serialVersionUID = 1L;
43  
44      protected final String stereoTypeName;
45  
46      protected final String prefixMessage;
47  
48      protected final Set<String> stack;
49  
50      public MissingStereoTypeException(String stereoTypeName, String prefixMessage, ObjectModelPackage aPackage, ObjectModelClass aClass) {
51          this.stereoTypeName = stereoTypeName;
52          this.prefixMessage = prefixMessage;
53          this.stack = getUsageStack(stereoTypeName, aPackage, aClass);
54      }
55  
56      @Override
57      public String toString() {
58  
59          return "\n\n" + prefixMessage
60                 + "\n=========================================================================================="
61                 + "\n" + Joiner.on("\n").join(stack)
62                 + "\n==========================================================================================";
63  
64      }
65  
66      /**
67       * Build the stack of usage of the given stereoType.
68       *
69       * Order of usage is : model, packages (from root to final package), then class.
70       *
71       * @param stereoTypeName name of stereotype
72       * @param aPackage package used
73       * @param aClass class used
74       * @return the ordered set of stack usage.
75       */
76      public LinkedHashSet<String> getUsageStack(String stereoTypeName, ObjectModelPackage aPackage, ObjectModelClass aClass) {
77          String suffix = ".stereotype=" + stereoTypeName;
78          LinkedHashSet<String> stack = new LinkedHashSet<>();
79  
80          stack.add("model" + suffix);
81  
82          addPackageStereoTypes(aPackage, suffix, stack);
83          stack.add(aClass.getQualifiedName() + ".class" + suffix);
84  
85          return stack;
86      }
87  
88      protected void addPackageStereoTypes(ObjectModelPackage aPackage, String suffix, Set<String> stack) {
89  
90          if (aPackage.getParentPackage() != null) {
91              addPackageStereoTypes(aPackage.getParentPackage(), suffix, stack);
92          }
93          stack.add("package." + aPackage.getName() + suffix);
94  
95      }
96  
97  }