jakarta.faces.webapp.AttributeTag Maven / Gradle / Ivy
Show all versions of jakarta.faces Show documentation
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.faces.webapp;
import jakarta.el.ELContext;
import jakarta.el.ExpressionFactory;
import jakarta.faces.component.UIComponent;
import jakarta.faces.context.FacesContext;
import jakarta.servlet.jsp.JspException;
import jakarta.servlet.jsp.tagext.TagSupport;
/**
*
* Tag implementation that adds an attribute with a specified name and String value to the component whose tag it is
* nested inside, if the component does not already contain an attribute with the same name. This tag creates no output
* to the page currently being created.
*
*
* @deprecated The Faces implementation must now provide the implementation for this class.
*/
@Deprecated
public class AttributeTag extends TagSupport {
// ---------------------------------------------------------- Static Members
private static final long serialVersionUID = -7782950243436672334L;
// ------------------------------------------------------------- Attributes
/**
*
* The name of the attribute to be created, if not already present.
*/
private String name = null;
/**
*
* Set the attribute name.
*
*
* @param name The new attribute name
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The value to be associated with this attribute, if it is created.
*
*/
private String value = null;
/**
*
* Set the attribute value.
*
*
* @param value The new attribute value
*/
public void setValue(String value) {
this.value = value;
}
// --------------------------------------------------------- Public Methods
/**
*
* Register the specified attribute name and value with the {@link UIComponent} instance associated with our most
* immediately surrounding {@link UIComponentTag} instance, if this {@link UIComponent} does not already have a value
* for the specified attribute name.
*
*
* @throws JspException if a Jakarta Server Pages error occurs
*/
@Override
public int doStartTag() throws JspException {
// Locate our parent UIComponentTag
UIComponentClassicTagBase tag = UIComponentClassicTagBase.getParentUIComponentClassicTagBase(pageContext);
if (tag == null) { // PENDING - i18n
throw new JspException("Not nested in a UIComponentTag");
}
// Add this attribute if it is not already defined
UIComponent component = tag.getComponentInstance();
if (component == null) { // PENDING - i18n
throw new JspException("No component associated with UIComponentTag");
}
FacesContext context = FacesContext.getCurrentInstance();
ExpressionFactory exprFactory = context.getApplication().getExpressionFactory();
ELContext elContext = context.getELContext();
String nameVal = (String) exprFactory.createValueExpression(elContext, name, String.class).getValue(elContext);
Object valueVal = exprFactory.createValueExpression(elContext, value, Object.class).getValue(elContext);
if (component.getAttributes().get(nameVal) == null) {
component.getAttributes().put(nameVal, valueVal);
}
return SKIP_BODY;
}
@Override
public int doEndTag() throws JspException {
release();
return EVAL_PAGE;
}
/**
*
* Release references to any acquired resources.
*/
@Override
public void release() {
name = null;
value = null;
}
}