View Javadoc

1   /*
2    * $Id: AttributeEvaluator.java 644022 2008-04-02 19:46:59Z apetrelli $
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  package org.apache.tiles.evaluator;
22  
23  import java.util.Map;
24  
25  import org.apache.tiles.Attribute;
26  import org.apache.tiles.context.TilesRequestContext;
27  
28  /***
29   * It represents an object that resolves a string to return an object.
30   *
31   * @version $Rev: 644022 $ $Date: 2008-04-02 21:46:59 +0200 (mer, 02 apr 2008) $
32   * @since 2.1.0
33   */
34  public interface AttributeEvaluator {
35  
36      /***
37       * Initializes the attribute evaluator.
38       *
39       * @param initParameters The initialization parameters.
40       * @since 2.1.0
41       */
42      void init(Map<String, String> initParameters);
43  
44      /***
45       * Evaluates an expression.
46       *
47       * @param expression The expression to evaluate.
48       * @param request The request object.
49       * @return The evaluated object.
50       * @since 2.1.0
51       */
52      Object evaluate(String expression, TilesRequestContext request);
53  
54      /***
55       * Evaluates an attribute value.
56       *
57       * @param attribute The attribute to evaluate.
58       * @param request The request object.
59       * @return The evaluated object.
60       * @since 2.1.0
61       */
62      Object evaluate(Attribute attribute, TilesRequestContext request);
63  }