View Javadoc
1   package org.codehaus.plexus.component.configurator.expression;
2   
3   /*
4    * Copyright 2001-2006 Codehaus Foundation.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * 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, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  import java.io.File;
20  
21  /**
22   * Evaluate an expression.
23   *
24   * @author <a href="mailto:brett@codehaus.org">Brett Porter</a>
25   * @version $Id$
26   */
27  public interface ExpressionEvaluator
28  {
29      String ROLE = ExpressionEvaluator.class.getName();
30      
31      /**
32       * Evaluate an expression.
33       *
34       * @param expression the expression
35       * @return the value of the expression
36       */
37      Object evaluate( String expression )
38          throws ExpressionEvaluationException;
39  
40      /**
41       * Align a given path to the base directory that can be evaluated by this expression evaluator, if known.
42       *
43       * @param file the file
44       * @return the aligned file
45       */
46      File alignToBaseDirectory( File file );
47  }