View Javadoc

1   package org.apache.maven.model.interpolation;
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 java.util.List;
23  
24  import org.apache.maven.model.building.ModelProblemCollector;
25  import org.apache.maven.model.building.ModelProblem.Severity;
26  import org.codehaus.plexus.interpolation.ValueSource;
27  
28  /**
29   * Wraps another value source and intercepts interpolated expressions, checking for problems.
30   * 
31   * @author Benjamin Bentmann
32   */
33  class ProblemDetectingValueSource
34      implements ValueSource
35  {
36  
37      private final ValueSource valueSource;
38  
39      private final String bannedPrefix;
40  
41      private final String newPrefix;
42  
43      private final ModelProblemCollector problems;
44  
45      public ProblemDetectingValueSource( ValueSource valueSource, String bannedPrefix, String newPrefix,
46                                          ModelProblemCollector problems )
47      {
48          this.valueSource = valueSource;
49          this.bannedPrefix = bannedPrefix;
50          this.newPrefix = newPrefix;
51          this.problems = problems;
52      }
53  
54      public Object getValue( String expression )
55      {
56          Object value = valueSource.getValue( expression );
57  
58          if ( value != null && expression.startsWith( bannedPrefix ) )
59          {
60              String msg = "The expression ${" + expression + "} is deprecated.";
61              if ( newPrefix != null && newPrefix.length() > 0 )
62              {
63                  msg += " Please use ${" + newPrefix + expression.substring( bannedPrefix.length() ) + "} instead.";
64              }
65              problems.add( Severity.WARNING, msg, null, null );
66          }
67  
68          return value;
69      }
70  
71      @SuppressWarnings( "unchecked" )
72      public List getFeedback()
73      {
74          return valueSource.getFeedback();
75      }
76  
77      public void clearFeedback()
78      {
79          valueSource.clearFeedback();
80      }
81  
82  }