enterprise/web.el/src/org/netbeans/modules/web/el/spi/ELVariableResolver.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.netbeans.modules.web.el.spi;

import java.util.List;
import org.netbeans.modules.parsing.api.Snapshot;
import org.openide.filesystems.FileObject;
import org.openide.util.Parameters;

public interface ELVariableResolver {

    /**
     * Gets the bean name of the given {@code clazz}.
     *
     * @param clazz the FQN of the class
     * @param target
     * @param context
     * @return the bean name of of the class or {@code null}.
     */
    String getBeanName(String clazz, FileObject target, ResolverContext context);

    /**
     * Gets the injectable field of the bean identified by the given {@code beanName}.
     *
     * @param beanName the bean name
     * @param target
     * @param context
     * @return the field if found or {@code null}.
     */
    FieldInfo getInjectableField(String beanName, FileObject target, ResolverContext context);

//    /**
//     * Gets the expression referred by the variable at the given {@code offset}.
//     * @param snapshot
//     * @param offset
//     * @return the referred expression or {@code null}.
//     */
//    String getReferredExpression(Snapshot snapshot, int offset);

    /**
     * Gets the names of managed beans and variables.
     * @param target
     * @param context
     * @return a list of bean infos; never {@code null}.
     */
    List<VariableInfo> getManagedBeans(FileObject target, ResolverContext context);

    /**
     * Gets all the variables available at the given offset.
     * 
     * @param snapshot
     * @param offset
     * @param context
     * @return a list of variable infos; never {@code null}.
     */
    List<VariableInfo> getVariables(Snapshot snapshot, int offset, ResolverContext context);

    /**
     * Gets the managed beans in the given {@code scope}.
     * @param scope the scope to search, e.g. {@code "session"} or {@code "application"}.
     * @param snapshot
     * @param context
     * @return a list of bean infos; never {@code null}.
     */
    List<VariableInfo> getBeansInScope(String scope, Snapshot snapshot, ResolverContext context);

    List<VariableInfo> getRawObjectProperties(String name, Snapshot snapshot, ResolverContext context);

    /**
     * Hold information about injectable field.
     */
    public static final class FieldInfo {

        /** The FQN of the class which is enclosing that field. */
        private final String enclosingClass;

        /** Return type of the field. */
        private final String type;

        /**
         * Constructor for injectable fields.
         * @param enclosingClass FQN of the enclosing class
         * @param type return type of the field
         */
        public FieldInfo(String enclosingClass, String type) {
            this.enclosingClass = enclosingClass;
            this.type = type;
        }

        /**
         * Constructor for injectable beans.
         * @param type FQN of the class
         */
        public FieldInfo(String type) {
            this.type = enclosingClass = type;
        }

        public String getEnclosingClass() {
            return enclosingClass;
        }

        public String getType() {
            return type;
        }
    }

    public static final class VariableInfo {

        public final String name;
        public final String clazz;
        public final String expression;

        public static VariableInfo createResolvedVariable(String name, String clazz) {
            Parameters.notNull("name", name); //NOI18N
            Parameters.notNull("clazz", clazz); //NOI18N
            
            return new VariableInfo(name, clazz, null);
        }
        
        public static VariableInfo createUnresolvedVariable(String name, String expression) {
            Parameters.notNull("name", name); //NOI18N
            Parameters.notNull("expression", expression); //NOI18N

            return new VariableInfo(name, null, expression);
        }

        public static VariableInfo createVariable(String name) {
            Parameters.notNull("name", name); //NOI18N

            return new VariableInfo(name, null, null);
        }

        private VariableInfo(String name, String clazz, String expression) {
            this.name = name;
            this.clazz = clazz;
            this.expression = expression;
        }
        
    }
}