001package org.apache.maven.exception;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *  http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.util.Collections;
023import java.util.List;
024
025/**
026 * Provide a summary of the exception, containing:<ul>
027 * <li>the exception itself,</li>
028 * <li>useful end-user message,</li>
029 * <li>useful reference to a solution, or set of solutions: this is usually a wiki page url in
030 * <a href="http://cwiki.apache.org/confluence/display/MAVEN/">http://cwiki.apache.org/confluence/display/MAVEN/</a>,
031 * </li>
032 * <li>child exception summaries.</li>
033 * </ul>
034 */
035public class ExceptionSummary
036{
037
038    private Throwable exception;
039
040    private String message;
041
042    private String reference;
043
044    private List<ExceptionSummary> children;
045
046    public ExceptionSummary( Throwable exception, String message, String reference )
047    {
048        this( exception, message, reference, null );
049    }
050
051    public ExceptionSummary( Throwable exception, String message, String reference, List<ExceptionSummary> children )
052    {
053        this.exception = exception;
054        this.message = ( message != null ) ? message : "";
055        this.reference = ( reference != null ) ? reference : "";
056        this.children = ( children != null ) ? children : Collections.<ExceptionSummary>emptyList();
057    }
058
059    public Throwable getException()
060    {
061        return exception;
062    }
063
064    public String getMessage()
065    {
066        return message;
067    }
068
069    public String getReference()
070    {
071        return reference;
072    }
073
074    public List<ExceptionSummary> getChildren()
075    {
076        return children;
077    }
078
079}