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.toolchain.building;
20  
21  import java.io.PrintWriter;
22  import java.io.StringWriter;
23  import java.util.ArrayList;
24  import java.util.List;
25  
26  import org.apache.maven.building.Problem;
27  
28  /**
29   * @since 3.3.0
30   */
31  public class ToolchainsBuildingException extends Exception {
32  
33      private final List<Problem> problems;
34  
35      /**
36       * Creates a new exception with the specified problems.
37       *
38       * @param problems The problems that cause this exception, must not be {@code null}.
39       */
40      public ToolchainsBuildingException(List<Problem> problems) {
41          super(toMessage(problems));
42  
43          this.problems = new ArrayList<>();
44          if (problems != null) {
45              this.problems.addAll(problems);
46          }
47      }
48  
49      /**
50       * Gets the problems that caused this exception.
51       *
52       * @return The problems that caused this exception, never {@code null}.
53       */
54      public List<Problem> getProblems() {
55          return problems;
56      }
57  
58      private static String toMessage(List<Problem> problems) {
59          StringWriter buffer = new StringWriter(1024);
60  
61          PrintWriter writer = new PrintWriter(buffer);
62  
63          writer.print(problems.size());
64          writer.print((problems.size() == 1) ? " problem was " : " problems were ");
65          writer.print("encountered while building the effective toolchains");
66          writer.println();
67  
68          for (Problem problem : problems) {
69              writer.print("[");
70              writer.print(problem.getSeverity());
71              writer.print("] ");
72              writer.print(problem.getMessage());
73              String location = problem.getLocation();
74              if (!location.isEmpty()) {
75                  writer.print(" @ ");
76                  writer.print(location);
77              }
78              writer.println();
79          }
80  
81          return buffer.toString();
82      }
83  }