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.rule.api; 020 021import org.codehaus.plexus.util.xml.Xpp3Dom; 022 023/** 024 * Entry point for custom {@code Enforcer Rule} which provide additional rules configuration. 025 * <p> 026 * Provided configuration will be added to current rules list by {@code Enforcer Mojo} 027 * 028 * @author Slawomir Jaranowski 029 * @since 3.2.1 030 */ 031public abstract class AbstractEnforcerRuleConfigProvider extends AbstractEnforcerRuleBase { 032 033 /** 034 * Produce rule configuration. 035 * <p> 036 * Returned configuration must contain rules configuration as in example: 037 * <pre> 038 * <rules> 039 * <ruleName/> 040 * <ruleName> 041 * <ruleConfig>config value</ruleConfig> 042 * </ruleName> 043 * </rules> 044 * </pre> 045 * 046 * @return a rules configuration 047 * @throws EnforcerRuleError the error during executing 048 */ 049 public abstract Xpp3Dom getRulesConfig() throws EnforcerRuleError; 050}