View Javadoc

1   package org.apache.maven.plugins.enforcer;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
23  import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
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  public class AlwaysFail
31      extends AbstractNonCacheableEnforcerRule
32  {
33  
34      /**
35       * {@inheritDoc}
36       */
37      public void execute( EnforcerRuleHelper helper )
38          throws EnforcerRuleException
39      {
40          String message = getMessage();
41          
42          StringBuffer buf = new StringBuffer();
43          if ( message != null )
44          {
45              buf.append( message ).append( '\n' );
46          }
47          buf.append( "Always fails!" );
48          throw new EnforcerRuleException( buf.toString() );
49      }
50  }