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 import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;
25
26 /**
27 * This rule checks that certain properties are set.
28 *
29 * @author Paul Gier
30 */
31 public class RequireProperty
32 extends AbstractPropertyEnforcerRule
33 {
34
35 /** Specify the required property. */
36 public String property = null;
37
38 @Override
39 public Object resolveValue( EnforcerRuleHelper helper )
40 throws EnforcerRuleException
41 {
42 Object propValue = null;
43 try
44 {
45 propValue = helper.evaluate( "${" + property + "}" );
46 }
47 catch ( ExpressionEvaluationException eee )
48 {
49 throw new EnforcerRuleException( "Unable to evaluate property: " + property, eee );
50 }
51 return propValue;
52 }
53
54 protected String resolveValue()
55 {
56 return null;
57 }
58
59 @Override
60 public String getPropertyName()
61 {
62 return property;
63 }
64
65 @Override
66 public String getName()
67 {
68 return "Property";
69 }
70 }