View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.enforcer.rules;
20  
21  import javax.inject.Named;
22  
23  import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
24  
25  /**
26   * Always fail. This rule is useful for testing the Enforcer configuration, or to always fail the build if a particular
27   * profile is enabled.
28   * @author Ben Lidgey
29   */
30  @Named("alwaysFail")
31  public final class AlwaysFail extends AbstractStandardEnforcerRule {
32  
33      @Override
34      public void execute() throws EnforcerRuleException {
35  
36          StringBuilder buf = new StringBuilder();
37          if (getMessage() != null) {
38              buf.append(getMessage()).append(System.lineSeparator());
39          }
40          buf.append("Always fails!");
41          throw new EnforcerRuleException(buf.toString());
42      }
43  
44      @Override
45      public String toString() {
46          return String.format("AlwaysFail[message=%s]", getMessage());
47      }
48  }