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  import java.lang.reflect.Member;
23  import java.util.Map;
24  
25  /**
26   * This interface provides a hook for preparing for accessing members of objects. The Java2 version of this method can
27   * allow access to otherwise inaccessable members, such as private fields.
28   * 
29   * @author Luke Blanshard (blanshlu@netscape.net)
30   * @author Drew Davidson (drew@ognl.org)
31   * @version 15 October 1999
32   */
33  public interface MemberAccess
34  {
35      /**
36       * Sets the member up for accessibility
37       */
38      Object setup( Map<String, Object> context, Object target, Member member, String propertyName );
39  
40      /**
41       * Restores the member from the previous setup call.
42       */
43      void restore( Map<String, Object> context, Object target, Member member, String propertyName, Object state );
44  
45      /**
46       * Returns true if the given member is accessible or can be made accessible by this object.
47       */
48      boolean isAccessible( Map<String, Object> context, Object target, Member member, String propertyName );
49  }