Apache Struts API Documentation: Class ResourceTag

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 ResourceTag

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

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

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

Define a scripting variable based on the contents of the specified web application resource.

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

Field Summary
`protected static int`	`BUFFER_SIZE` Buffer size to use when reading the input stream.
`protected java.lang.String`	`id` The name of the scripting variable that will be exposed as a page scope attribute.
`protected java.lang.String`	`input` Return an InputStream to the specified resource if this is non-null.
`protected static MessageResources`	`messages` The message resources for this package.
`protected java.lang.String`	`name` The module-relative URI of the resource whose contents are to be exposed.

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
`ResourceTag()`

Method Summary
`int`	`doStartTag()` Retrieve the required property and expose it as a scripting variable.
`java.lang.String`	`getId()`
`java.lang.String`	`getInput()`
`java.lang.String`	`getName()`
`void`	`release()` Release all allocated resources.
`void`	`setId(java.lang.String id)`
`void`	`setInput(java.lang.String input)`
`void`	`setName(java.lang.String name)`

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

BUFFER_SIZE

protected static final int BUFFER_SIZE

Buffer size to use when reading the input stream.

id

protected java.lang.String id

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

input

protected java.lang.String input

Return an InputStream to the specified resource if this is non-null.

messages

protected static MessageResources messages

The message resources for this package.

name

protected java.lang.String name

The module-relative URI of the resource whose contents are to be exposed.

Constructor Detail

ResourceTag

public ResourceTag()

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

getInput

public java.lang.String getInput()

setInput

public void setInput(java.lang.String input)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

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