org.apache.taglibs.standard.tag.common.core.RemoveTag Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the "License"). You may not use this file except
* in compliance with the License.
*
* You can obtain a copy of the license at
* glassfish/bootstrap/legal/CDDLv1.0.txt or
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* HEADER in each file and include the License file at
* glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
* add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your
* own identifying information: Portions Copyright [yyyy]
* [name of copyright owner]
*
* Copyright 2005 Sun Microsystems, Inc. All rights reserved.
*
* Portions Copyright Apache Software Foundation.
*/
package org.apache.taglibs.standard.tag.common.core;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.PageContext;
import javax.servlet.jsp.tagext.TagSupport;
/**
* A handler for the <remove> tag, which removes the variable
* identified by 'var' (and 'scope', if present).
*
* @author Shawn Bayern
*/
public class RemoveTag extends TagSupport {
//*********************************************************************
// Constants
/* We support these 'scopes'. */
private final String APPLICATION = "application";
private final String SESSION = "session";
private final String REQUEST = "request";
private final String PAGE = "page";
//*********************************************************************
// Internal state
private int scope; // tag attribute
private boolean scopeSpecified; // ... by tag attribute
private String var; // tag attribute
//*********************************************************************
// Construction and initialization
/**
* Constructs a new handler. As with TagSupport, subclasses should
* not provide other constructors and are expected to call the
* superclass constructor.
*/
public RemoveTag() {
super();
init();
}
// resets local state
private void init() {
var = null;
scope = PageContext.PAGE_SCOPE;
scopeSpecified = false;
}
// Releases any resources we may have (or inherit)
public void release() {
super.release();
init();
}
//*********************************************************************
// Tag logic
// removes the variable (from a specific scope, if specified)
public int doEndTag() throws JspException {
if (!scopeSpecified)
pageContext.removeAttribute(var);
else
pageContext.removeAttribute(var, scope);
return EVAL_PAGE;
}
//*********************************************************************
// Accessor methods
// for tag attribute
public void setVar(String var) {
this.var = var;
}
// for tag attribute
public void setScope(String scope) {
this.scope = Util.getScope(scope);
scopeSpecified = true;
}
}