View Javadoc

1   package org.apache.commons.ognl;
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  /**
23   * Defines an object that can return a representation of itself and any objects it contains in the form of a
24   * {@link String} embedded with literal java statements.
25   *
26   * @author jkuhnert
27   */
28  public interface JavaSource
29  {
30  
31      /**
32       * Expected to return a java source representation of itself such that it could be turned into a literal java
33       * expression to be compiled and executed for
34       * {@link org.apache.commons.ognl.enhance.ExpressionAccessor#get(OgnlContext, Object)} calls.
35       *
36       * @return Literal java string representation of an object get.
37       */
38      String toGetSourceString( OgnlContext context, Object target );
39  
40      /**
41       * Expected to return a java source representation of itself such that it could be turned into a literal java
42       * expression to be compiled and executed for
43       * {@link org.apache.commons.ognl.enhance.ExpressionAccessor#get(OgnlContext, Object)} calls.
44       *
45       * @return Literal java string representation of an object get.
46       */
47      String toSetSourceString( OgnlContext context, Object target );
48  
49  }