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.api.services;
20  
21  import java.util.ArrayList;
22  import java.util.Comparator;
23  import java.util.List;
24  
25  import org.apache.maven.api.annotations.Experimental;
26  
27  /**
28   * Base class for all maven exceptions carrying {@link BuilderProblem}s.
29   *
30   * @since 4.0.0
31   */
32  @Experimental
33  public abstract class MavenBuilderException extends MavenException {
34  
35      private final List<BuilderProblem> problems;
36  
37      public MavenBuilderException(String message, Throwable cause) {
38          super(message, cause);
39          problems = List.of();
40      }
41  
42      public MavenBuilderException(String message, List<BuilderProblem> problems) {
43          super(buildMessage(message, problems), null);
44          this.problems = problems;
45      }
46  
47      /**
48       * Formats message out of problems: problems are sorted (in natural order of {@link BuilderProblem.Severity})
49       * and then a list is built. These exceptions are usually thrown in "fatal" cases (and usually prevent Maven
50       * from starting), and these exceptions may end up very early on output.
51       */
52      protected static String buildMessage(String message, List<BuilderProblem> problems) {
53          StringBuilder msg = new StringBuilder(message);
54          ArrayList<BuilderProblem> sorted = new ArrayList<>(problems);
55          sorted.sort(Comparator.comparing(BuilderProblem::getSeverity));
56          for (BuilderProblem problem : sorted) {
57              msg.append("\n * ")
58                      .append(problem.getSeverity().name())
59                      .append(": ")
60                      .append(problem.getMessage());
61          }
62          return msg.toString();
63      }
64  
65      public List<BuilderProblem> getProblems() {
66          return problems;
67      }
68  }