org.netbeans.modules.web.jspparser.WebAppParseProxy Maven / Gradle / Ivy

Go to download
/*
 * 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.jspparser;

import java.io.IOException;
import java.net.URLClassLoader;
import java.util.Map;
import org.netbeans.modules.web.api.webmodule.WebModule;
import org.netbeans.modules.web.jsps.parserapi.JspParserAPI;
import org.openide.filesystems.FileObject;

/** Class that provides JSP parsing support for one web application. It caches
 * some useful data on a per-webapp basis.

 *
 * Among other things, it does the following to correctly manage the development cycle:
 * 
 *   Creates the correct classloader for loading JavaBeans, tag hanlders and other classes managed by the application.
 *   Caches the ServletContext (needed by the parser) corresponding to the application.
 *   Listens on changes in the application and releases caches as needed.
 * 
 * @author Petr Jiricka
 */
public interface WebAppParseProxy {
    
   
    JspParserAPI.JspOpenInfo getJspOpenInfo(FileObject jspFile, boolean useEditor);
    
    JspParserAPI.ParseResult analyzePage(FileObject jspFile, int errorReportingMode);
    
    Map getTaglibMap(boolean useEditor) throws IOException;
    
    URLClassLoader getWAClassLoader();

    // #146242
    boolean isValid(WebModule module);
}