enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AlwaysFail.java

package org.apache.maven.plugins.enforcer;

/*
 * 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.enforcer.rule.api.EnforcerRuleException;
import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;

/**
 * Always fail. This rule is useful for testing the Enforcer configuration, or to always fail the build if a particular
 * profile is enabled.
 * @author Ben Lidgey
 */
public class AlwaysFail
    extends AbstractNonCacheableEnforcerRule
{

    @Override
    public void execute( EnforcerRuleHelper helper )
        throws EnforcerRuleException
    {
        String message = getMessage();
        
        StringBuffer buf = new StringBuffer();
        if ( message != null )
        {
            buf.append( message ).append( System.lineSeparator() );
        }
        buf.append( "Always fails!" );
        throw new EnforcerRuleException( buf.toString() );
    }
}