javax.faces.webapp.FacetTag Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2015 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://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/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 packager/legal/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.faces.webapp;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.TagSupport;
/**
* FacetTag is the JSP mechanism for denoting a
* {@link javax.faces.component.UIComponent} is to be added as a
* facet to the component associated with its parent.
*
* A FacetTag must have one and only one
* child. This child must be a {@link UIComponentTag} instance representing
* a single {@link javax.faces.component.UIComponent} instance.
*/
public class FacetTag extends TagSupport {
// -------------------------------------------------------------- Properties
private static final long serialVersionUID = 5019035861261307895L;
/**
* The name of this facet. This will be used as the facet name for
* our UIComponentTag child in our UIComponentTag
* parent's facet list.
*/
private String name = null;
/**
* Return the name to be assigned to this facet.
*
* @return the name
*/
public String getName() {
return (name);
}
/**
* Set the name to be assigned to this facet.
*
* @param name The new facet name
*/
public void setName(String name) {
this.name = name;
}
// ------------------------------------------------------------- Tag Methods
/**
* Release any resources allocated by this tag instance.
*/
@Override
public void release() {
super.release();
this.name = null;
}
/**
*
Return EVAL_BODY_INCLUDE to cause nested body
* content to be evaluated.
*/
@Override
public int doStartTag() throws JspException {
return (EVAL_BODY_INCLUDE);
}
}