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