View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.plugin.compiler;
20  
21  import java.util.List;
22  
23  import org.apache.maven.plugin.MojoFailureException;
24  import org.codehaus.plexus.compiler.CompilerMessage;
25  
26  /**
27   * @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
28   * @since 2.0
29   */
30  @SuppressWarnings("serial")
31  public class CompilationFailureException extends MojoFailureException {
32      private static final String LS = System.getProperty("line.separator");
33  
34      /**
35       * Wrap error messages from the compiler
36       *
37       * @param messages the messages, not null
38       * @since 2.0
39       */
40      public CompilationFailureException(List<CompilerMessage> messages) {
41          super(null, shortMessage(messages), longMessage(messages));
42      }
43  
44      /**
45       * Long message will have all messages, one per line
46       *
47       * @param messages the messages, not null
48       * @return the long error message
49       * @since 2.0
50       */
51      public static String longMessage(List<CompilerMessage> messages) {
52          StringBuilder sb = new StringBuilder();
53  
54          for (CompilerMessage compilerError : messages) {
55              sb.append(compilerError).append(LS);
56          }
57  
58          return sb.toString();
59      }
60  
61      /**
62       * Short message will have the error message if there's only one, useful for errors forking the compiler
63       *
64       * @param messages the messages, not null
65       * @return the short error message
66       * @since 2.0.2
67       */
68      public static String shortMessage(List<CompilerMessage> messages) {
69          StringBuilder sb = new StringBuilder("Compilation failure");
70  
71          if (messages.size() == 1) {
72              sb.append(LS).append(messages.get(0)).append(LS);
73          }
74  
75          return sb.toString();
76      }
77  }