001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.maven.enforcer.rules;
020
021import javax.inject.Named;
022
023import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
024
025/**
026 * Always fail. This rule is useful for testing the Enforcer configuration, or to always fail the build if a particular
027 * profile is enabled.
028 * @author Ben Lidgey
029 */
030@Named("alwaysFail")
031public final class AlwaysFail extends AbstractStandardEnforcerRule {
032
033    @Override
034    public void execute() throws EnforcerRuleException {
035
036        StringBuilder buf = new StringBuilder();
037        if (getMessage() != null) {
038            buf.append(getMessage()).append(System.lineSeparator());
039        }
040        buf.append("Always fails!");
041        throw new EnforcerRuleException(buf.toString());
042    }
043
044    @Override
045    public String toString() {
046        return String.format("AlwaysFail[message=%s]", getMessage());
047    }
048}