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.plugin; 20 21 import org.apache.maven.api.annotations.Experimental; 22 import org.apache.maven.api.services.MavenException; 23 24 /** 25 * An exception occurring during the execution of a plugin. 26 * 27 * @since 4.0.0 28 */ 29 @Experimental 30 public class MojoException extends MavenException { 31 32 protected Object source; 33 34 protected String longMessage; 35 36 /** 37 * Constructs a new {@code MojoException} providing the source and a short and long message. 38 * These messages are used to improve the message written at the end of Maven build. 39 */ 40 public MojoException(Object source, String shortMessage, String longMessage) { 41 super(shortMessage); 42 this.source = source; 43 this.longMessage = longMessage; 44 } 45 46 /** 47 * Constructs a new {@code MojoException} wrapping an underlying {@code Throwable} 48 * and providing a {@code message}. 49 */ 50 public MojoException(String message, Throwable cause) { 51 super(message, cause); 52 } 53 54 /** 55 * Constructs a new {@code MojoException} providing a {@code message}. 56 */ 57 public MojoException(String message) { 58 super(message); 59 } 60 61 /** 62 * Constructs a new {@code MojoExecutionException} wrapping an underlying {@code Throwable}. 63 * 64 * @param cause the cause which is saved for later retrieval by the {@link #getCause()} method. 65 * A {@code null} value is permitted, and indicates that the cause is nonexistent or unknown. 66 */ 67 public MojoException(Throwable cause) { 68 super(cause); 69 } 70 71 public String getLongMessage() { 72 return longMessage; 73 } 74 75 public Object getSource() { 76 return source; 77 } 78 }