001    package org.apache.commons.ognl;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     *   http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    import java.lang.reflect.Member;
023    import java.util.Map;
024    
025    /**
026     * This interface provides a hook for preparing for accessing members of objects. The Java2 version of this method can
027     * allow access to otherwise inaccessable members, such as private fields.
028     * 
029     * @author Luke Blanshard (blanshlu@netscape.net)
030     * @author Drew Davidson (drew@ognl.org)
031     * @version 15 October 1999
032     */
033    public interface MemberAccess
034    {
035        /**
036         * Sets the member up for accessibility
037         */
038        Object setup( Map<String, Object> context, Object target, Member member, String propertyName );
039    
040        /**
041         * Restores the member from the previous setup call.
042         */
043        void restore( Map<String, Object> context, Object target, Member member, String propertyName, Object state );
044    
045        /**
046         * Returns true if the given member is accessible or can be made accessible by this object.
047         */
048        boolean isAccessible( Map<String, Object> context, Object target, Member member, String propertyName );
049    }