View Javadoc

1   package org.apache.maven.exception;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.util.Collections;
23  import java.util.List;
24  
25  // provide a
26  // - the exception
27  // - useful message
28  // - useful reference to a solution, or set of solutions
29  // - the configuration gleaned for examination
30  // - plugin repositories
31  
32  public class ExceptionSummary
33  {
34  
35      private Throwable exception;
36  
37      private String message;
38  
39      private String reference;
40  
41      private List<ExceptionSummary> children;
42  
43      public ExceptionSummary( Throwable exception, String message, String reference )
44      {
45          this( exception, message, reference, null );
46      }
47  
48      public ExceptionSummary( Throwable exception, String message, String reference, List<ExceptionSummary> children )
49      {
50          this.exception = exception;
51          this.message = ( message != null ) ? message : "";
52          this.reference = ( reference != null ) ? reference : "";
53          this.children = ( children != null ) ? children : Collections.<ExceptionSummary> emptyList();
54      }
55  
56      public Throwable getException()
57      {
58          return exception;
59      }
60  
61      public String getMessage()
62      {
63          return message;
64      }
65  
66      public String getReference()
67      {
68          return reference;
69      }
70  
71      public List<ExceptionSummary> getChildren()
72      {
73          return children;
74      }
75  
76  }