org.codehaus.mojo.tidy.CheckMojo Maven / Gradle / Ivy

Go to download

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

Tidy Plugin for Maven. The Tidy plugin provides goals for tidying up your source code.

There is a newer version: 1.3.0

package org.codehaus.mojo.tidy;

/*
 * 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.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;

/**
 * Checks that the pom.xml is tidy. Fails the build if mvn tidy:pom would
 * create a different pom.xml than the current one.
 */
@Mojo( name = "check", defaultPhase = LifecyclePhase.VERIFY )
public class CheckMojo
    extends TidyMojo
{
    @Override
    protected void executeForPom( String pom )
        throws MojoExecutionException, MojoFailureException
    {
        String tidyPom = tidy( pom );
        if ( !pom.equals( tidyPom ) )
        {
            throw new MojoFailureException(
                "The POM violates the code style. Please format it by running `mvn tidy:pom`." );
        }
    }
}