Apache Struts API Documentation: Class CookieTag

Apache Struts API

previous page next page

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.struts.taglib.bean Class CookieTag

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--org.apache.struts.taglib.bean.CookieTag

All Implemented Interfaces:: java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class CookieTag
extends javax.servlet.jsp.tagext.TagSupport

Define a scripting variable based on the value(s) of the specified cookie received with this request.

Version:: $Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $
See Also:: Serialized Form

Field Summary
`protected java.lang.String`	`id` The name of the scripting variable that will be exposed as a page scope attribute.
`protected static MessageResources`	`messages` The message resources for this package.
`protected java.lang.String`	`multiple` Return an array of Cookies if `multiple` is non-null.
`protected java.lang.String`	`name` The name of the cookie whose value is to be exposed.
`protected java.lang.String`	`value` The default value to return if no cookie of the specified name is found.

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

pageContext, parent, values

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary
`CookieTag()`

Method Summary
`int`	`doStartTag()` Retrieve the required property and expose it as a scripting variable.
`java.lang.String`	`getId()`
`java.lang.String`	`getMultiple()`
`java.lang.String`	`getName()`
`java.lang.String`	`getValue()`
`void`	`release()` Release all allocated resources.
`void`	`setId(java.lang.String id)`
`void`	`setMultiple(java.lang.String multiple)`
`void`	`setName(java.lang.String name)`
`void`	`setValue(java.lang.String value)`

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doEndTag, findAncestorWithClass, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

Field Detail

id

protected java.lang.String id

The name of the scripting variable that will be exposed as a page scope attribute.

messages

protected static MessageResources messages

The message resources for this package.

multiple

protected java.lang.String multiple

Return an array of Cookies if multiple is non-null.

name

protected java.lang.String name

The name of the cookie whose value is to be exposed.

value

protected java.lang.String value

The default value to return if no cookie of the specified name is found.

Constructor Detail

CookieTag

public CookieTag()

Method Detail

getId

public java.lang.String getId()

Overrides:: getId in class javax.servlet.jsp.tagext.TagSupport

setId

public void setId(java.lang.String id)

Overrides:: setId in class javax.servlet.jsp.tagext.TagSupport

getMultiple

public java.lang.String getMultiple()

setMultiple

public void setMultiple(java.lang.String multiple)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getValue

public java.lang.String getValue()

setValue

public void setValue(java.lang.String value)

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Retrieve the required property and expose it as a scripting variable.

Overrides:: doStartTag in class javax.servlet.jsp.tagext.TagSupport

Throws:: javax.servlet.jsp.JspException - if a JSP exception has occurred

release

public void release()

Release all allocated resources.

Overrides:: release in class javax.servlet.jsp.tagext.TagSupport