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 /**
36 * Specify the required property.
37 *
38 * @see {@link #setProperty(String)}
39 * @see {@link #getPropertyName()}
40 */
41 private String property = null;
42
43 public final void setProperty( String property )
44 {
45 this.property = property;
46 }
47
48 @Override
49 public Object resolveValue( EnforcerRuleHelper helper )
50 throws EnforcerRuleException
51 {
52 Object propValue = null;
53 try
54 {
55 propValue = helper.evaluate( "${" + property + "}" );
56 }
57 catch ( ExpressionEvaluationException eee )
58 {
59 throw new EnforcerRuleException( "Unable to evaluate property: " + property, eee );
60 }
61 return propValue;
62 }
63
64 protected String resolveValue()
65 {
66 return null;
67 }
68
69 @Override
70 public String getPropertyName()
71 {
72 return property;
73 }
74
75 @Override
76 public String getName()
77 {
78 return "Property";
79 }
80 }