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.plugins.enforcer.internal; 020 021import org.apache.maven.enforcer.rule.api.EnforcerLevel; 022import org.apache.maven.enforcer.rule.api.EnforcerRuleBase; 023 024/** 025 * Description of rule to execute. 026 * 027 * @author Slawomir Jaranowski 028 * @since 3.2.0 029 */ 030public final class EnforcerRuleDesc { 031 032 private final String name; 033 034 private final EnforcerRuleBase rule; 035 036 /** 037 * Create a new Rule Description 038 * 039 * @param name a rule name 040 * @param rule a rule instance 041 */ 042 public EnforcerRuleDesc(String name, EnforcerRuleBase rule) { 043 this.name = name; 044 this.rule = rule; 045 } 046 047 public String getName() { 048 return name; 049 } 050 051 public EnforcerRuleBase getRule() { 052 return rule; 053 } 054 055 public EnforcerLevel getLevel() { 056 return rule.getLevel(); 057 } 058 059 @Override 060 public String toString() { 061 return String.format("EnforcerRuleDesc[name=%s, rule=%s, level=%s]", name, rule, getLevel()); 062 } 063}