javax.servlet.descriptor.JspConfigDescriptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javaee-web-api Show documentation
Java(TM) EE 8 Web Profile Specification APIs
There is a newer version: 8.0.1
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2017-2017 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
 * or LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package javax.servlet.descriptor;

import java.util.Collection;

/**
 * This interface provides access to the <jsp-config>
 * related configuration of a web application.
 *
 * The configuration is aggregated from the web.xml and
 * web-fragment.xml descriptor files of the web application.
 *
 * @since Servlet 3.0
 */
public interface JspConfigDescriptor {

    /**
     * Gets the <taglib> child elements of the
     * <jsp-config> element represented by this
     * JspConfigDescriptor.
     *
     * 
Any changes to the returned Collection must not 
     * affect this JspConfigDescriptor.
     *
     * @return a (possibly empty) Collection of the
     * <taglib> child elements of the
     * <jsp-config> element represented by this
     * JspConfigDescriptor
     */
    public Collection getTaglibs();

    /**
     * Gets the <jsp-property-group> child elements
     * of the <jsp-config> element represented by this
     * JspConfigDescriptor.
     *
     * Any changes to the returned Collection must not 
     * affect this JspConfigDescriptor.
     *
     * @return a (possibly empty) Collection of the
     * <jsp-property-group> child elements of the
     * <jsp-config> element represented by this
     * JspConfigDescriptor
     */
    public Collection getJspPropertyGroups();
}