MojoFailureExceptionMojo.java

package org.apache.maven.plugin.coreit;

/*
 * 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.
 */

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoFailureException;

/**
 * @goal mojo-failure-exception
 * @requiresProject false
 */
public class MojoFailureExceptionMojo
    extends AbstractMojo
{
    /**
     * Message used in {@link MojoFailureException#MojoFailureException(String)}, unless longMessage
     * is supplied; then, this becomes the short message in {@link MojoFailureException#MojoFailureException(Object, String, String)}.
     * 
     * @parameter expression="${error.message}" default-value="Planned MojoExecutionException."
     * @required
     */
    private String message;
    
    /**
     * If supplied, The form {@link MojoFailureException#MojoFailureException(Object, String, String)} will be used.
     * 
     * @parameter expression="${error.longMessage}"
     * @required
     */
    private String longMessage;
    
    /**
     * @parameter expression="${error.source}"
     */
    private String source;

    public void execute()
        throws MojoFailureException
    {
        if ( longMessage != null )
        {
            throw new MojoFailureException( source, message, longMessage );
        }
        else
        {
            throw new MojoFailureException( message );
        }
    }
}