org.apache.maven.plugin.MojoFailureException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven-plugin-api Show documentation

The API for plugins - Mojos - development.

There is a newer version: 4.0.0-rc-2

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.maven.plugin;

/**
 * An exception occurring during the execution of a plugin (such as a compilation failure).

 * Throwing this exception causes a "BUILD FAILURE" message to be displayed.
 *
 */
public class MojoFailureException extends AbstractMojoExecutionException {
    /**
     * Construct a new MojoFailureException exception providing the source and a short and long message:
     * these messages are used to improve the message written at the end of Maven build.
     *
     * @param source
     * @param shortMessage
     * @param longMessage
     */
    public MojoFailureException(Object source, String shortMessage, String longMessage) {
        super(shortMessage);
        this.source = source;
        this.longMessage = longMessage;
    }

    /**
     * Construct a new MojoFailureException exception providing a message.
     *
     * @param message
     */
    public MojoFailureException(String message) {
        super(message);
    }

    /**
     * Construct a new MojoFailureException exception wrapping an underlying Throwable
     * and providing a message.
     *
     * @param message
     * @param cause
     * @since 2.0.9
     */
    public MojoFailureException(String message, Throwable cause) {
        super(message, cause);
    }

    /**
     * Constructs a new {@code MojoFailureException} exception wrapping an underlying {@code Throwable}.
     *
     * @param cause the cause which is saved for later retrieval by the {@link #getCause()} method.
     *              A {@code null} value is permitted, and indicates that the cause is nonexistent or unknown.
     * @since 3.8.3
     */
    public MojoFailureException(Throwable cause) {
        super(cause);
    }
}