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.exception;
20
21 import java.util.Collections;
22 import java.util.List;
23
24 /**
25 * Provide a summary of the exception, containing:<ul>
26 * <li>the exception itself,</li>
27 * <li>useful end-user message,</li>
28 * <li>useful reference to a solution, or set of solutions: this is usually a wiki page url in
29 * <a href="http://cwiki.apache.org/confluence/display/MAVEN/">http://cwiki.apache.org/confluence/display/MAVEN/</a>,
30 * </li>
31 * <li>child exception summaries.</li>
32 * </ul>
33 */
34 public class ExceptionSummary {
35
36 private Throwable exception;
37
38 private String message;
39
40 private String reference;
41
42 private List<ExceptionSummary> children;
43
44 public ExceptionSummary(Throwable exception, String message, String reference) {
45 this(exception, message, reference, null);
46 }
47
48 public ExceptionSummary(Throwable exception, String message, String reference, List<ExceptionSummary> children) {
49 this.exception = exception;
50 this.message = (message != null) ? message : "";
51 this.reference = (reference != null) ? reference : "";
52 this.children = (children != null) ? Collections.unmodifiableList(children) : Collections.emptyList();
53 }
54
55 public Throwable getException() {
56 return exception;
57 }
58
59 public String getMessage() {
60 return message;
61 }
62
63 public String getReference() {
64 return reference;
65 }
66
67 public List<ExceptionSummary> getChildren() {
68 return children;
69 }
70 }