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 jboss-servlet-api_3.0_spec Show documentation
The Java Servlet 3.0 API classes
The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2009 Sun Microsystems, Inc. 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://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/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 glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [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<>/code> 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();
}