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.myfaces.view.facelets.el;
20  
21  import javax.el.VariableMapper;
22  
23  /**
24   * Defines an interface to detect when an EL expression has been
25   * resolved by a facelets variable mapper and in that way allow cache it
26   * if it is possible. This class should be implemented by any 
27   * "facelets contextual" variable mapper.
28   * 
29   * @since 2.0.8
30   * @author Leonardo Uribe
31   *
32   */
33  public abstract class VariableMapperBase extends VariableMapper
34  {
35  
36      /**
37       * Check if a variable has been resolved by this variable mapper
38       * or any parent "facelets contextual" variable mapper.
39       * 
40       * @return
41       */
42      public abstract boolean isAnyFaceletsVariableResolved();
43  
44      /**
45       * Indicates an expression will be resolved, so preparations
46       * should be done to detect if a contextual variable has been resolved.
47       */
48      public abstract void beforeConstructELExpression();
49  
50      /**
51       * Cleanup all initialization done.
52       */
53      public abstract void afterConstructELExpression();
54  }