View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.model.interpolation;
20  
21  import java.util.List;
22  
23  import org.codehaus.plexus.interpolation.AbstractDelegatingValueSource;
24  import org.codehaus.plexus.interpolation.PrefixedValueSourceWrapper;
25  import org.codehaus.plexus.interpolation.QueryEnabledValueSource;
26  
27  /**
28   * Wraps an arbitrary object with an {@link ObjectBasedValueSource} instance, then
29   * wraps that source with a {@link PrefixedValueSourceWrapper} instance, to which
30   * this class delegates all of its calls.
31   */
32  public class PrefixedObjectValueSource extends AbstractDelegatingValueSource implements QueryEnabledValueSource {
33  
34      /**
35       * Wrap the specified root object, allowing the specified expression prefix.
36       * @param prefix the prefix.
37       * @param root the root of the graph.
38       */
39      public PrefixedObjectValueSource(String prefix, Object root) {
40          super(new PrefixedValueSourceWrapper(new ObjectBasedValueSource(root), prefix));
41      }
42  
43      /**
44       * Wrap the specified root object, allowing the specified list of expression
45       * prefixes and setting whether the {@link PrefixedValueSourceWrapper} allows
46       * unprefixed expressions.
47       * @param possiblePrefixes The possible prefixes.
48       * @param root The root of the graph.
49       * @param allowUnprefixedExpressions if we allow undefined expressions or not.
50       */
51      public PrefixedObjectValueSource(List<String> possiblePrefixes, Object root, boolean allowUnprefixedExpressions) {
52          super(new PrefixedValueSourceWrapper(
53                  new ObjectBasedValueSource(root), possiblePrefixes, allowUnprefixedExpressions));
54      }
55  
56      /**
57       * {@inheritDoc}
58       */
59      public String getLastExpression() {
60          return ((QueryEnabledValueSource) getDelegate()).getLastExpression();
61      }
62  }