You are viewing a plain text version of this content. The canonical link for it is here.
Posted to servletapi-dev@jakarta.apache.org by ed...@locus.apache.org on 2000/10/26 08:28:06 UTC
cvs commit: jakarta-servletapi/src/share/javax/servlet/jsp/tagext BodyTag.java IterationTag.java Tag.java TagLibraryInfo.java TagLibraryValidator.java TagSupport.java TagVariableInfo.java
eduardop 00/10/25 23:28:05
Modified: src/share/javax/servlet/jsp/tagext Tag: SERVLET_23_JSP_12
BodyTag.java IterationTag.java Tag.java
TagLibraryInfo.java TagLibraryValidator.java
TagSupport.java TagVariableInfo.java
Log:
Last batc of changes before "Proposed Final Draft".
Includes typos, clarifications of Tag protocols.
Revision Changes Path
No revision
No revision
1.1.1.1.4.3 +9 -0 jakarta-servletapi/src/share/javax/servlet/jsp/tagext/BodyTag.java
Index: BodyTag.java
===================================================================
RCS file: /home/cvs/jakarta-servletapi/src/share/javax/servlet/jsp/tagext/BodyTag.java,v
retrieving revision 1.1.1.1.4.2
retrieving revision 1.1.1.1.4.3
diff -u -r1.1.1.1.4.2 -r1.1.1.1.4.3
--- BodyTag.java 2000/10/13 23:13:39 1.1.1.1.4.2
+++ BodyTag.java 2000/10/26 06:28:00 1.1.1.1.4.3
@@ -101,6 +101,15 @@
* setBodyContent() and before the body evaluation. This method is only
* invoked if doStartTag() returns EVAL_BODY_BUFFERED.
*
+ * <p><B>Lifecycle</B>
+ * <p> Lifecycle details are described by the transition diagram below.
+ * Exceptions that are thrown during the computation of doStartTag(),
+ * setBodyContent(), doInitBody(), BODY, doAfterBody() interrupt the
+ * execution sequence and are propagated up the stack, unless the
+ * tag handler implements the TryCatchFinally interface; see that
+ * interface for details.
+ * <p>
+ * <IMG src="doc-files/BodyTagProtocol.gif"/>
*/
public interface BodyTag extends IterationTag {
1.1.2.2 +11 -1 jakarta-servletapi/src/share/javax/servlet/jsp/tagext/Attic/IterationTag.java
Index: IterationTag.java
===================================================================
RCS file: /home/cvs/jakarta-servletapi/src/share/javax/servlet/jsp/tagext/Attic/IterationTag.java,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- IterationTag.java 2000/08/24 21:05:28 1.1.2.1
+++ IterationTag.java 2000/10/26 06:28:00 1.1.2.2
@@ -70,7 +70,17 @@
* If doAfterBody() returns Tag.SKIP_BODY, then the body will be skipped
* and doEndTag() will be evaluated instead.
*
- */
+ * <p><B>Lifecycle</B>
+ *
+ * <p> Lifecycle details are described by the transition diagram
+ * below. Exceptions that are thrown during the computation of
+ * doStartTag(), BODY and doAfterBody() interrupt the execution
+ * sequence and are propagated up the stack, unless the tag handler
+ * implements the TryCatchFinally interface; see that interface for
+ * details.
+ *
+ * <p>
+ * <IMG src="doc-files/IterationTagProtocol.gif"/> */
public interface IterationTag extends Tag {
1.1.1.1.4.3 +24 -18 jakarta-servletapi/src/share/javax/servlet/jsp/tagext/Tag.java
Index: Tag.java
===================================================================
RCS file: /home/cvs/jakarta-servletapi/src/share/javax/servlet/jsp/tagext/Tag.java,v
retrieving revision 1.1.1.1.4.2
retrieving revision 1.1.1.1.4.3
diff -u -r1.1.1.1.4.2 -r1.1.1.1.4.3
--- Tag.java 2000/10/13 23:13:40 1.1.1.1.4.2
+++ Tag.java 2000/10/26 06:28:01 1.1.1.1.4.3
@@ -73,11 +73,6 @@
* <p> The JSP page implementation object invokes setPageContext and
* setParent, in that order, before invoking doStartTag() or doEndTag().
*
- * <p> The JSP 1.2 specification has the resetCustomProperties()
- * method to reset all custom properties to default values. Note that the
- * JSP translator can determine whether a specific tag handler class supports
- * or not this method.
- *
* <p><B>Methods</B>
*
* <p>
@@ -95,11 +90,30 @@
* are completed, the release method is invoked on it. Once a release
* method is invoked <em>all</em> properties, including parent and
* pageContext, are assumed to have been reset to an unspecified value.
- * The page compiler guarantees that release will be invoked on the Tag
- * handler before the end of the page.
+ * The page compiler guarantees that release() will be invoked on the Tag
+ * handler before the handler is released to the GC.
+ *
*
- * <p> Lifecycle details are collected elsewhere in the JSP specification
- * document.
+ * <p><B>Lifecycle</B>
+ * <p> Lifecycle details are described by the transition diagram below,
+ * with the following comments:
+ * <ul>
+ * <li> [1] This transition is intended to be for releasing long-term data.
+ * no guarantees are assumed on whether any properties have been retained
+ * or not.
+ * <li> [2] This transition happens if and only if the tag ends normally
+ * without raising an exception
+ * <li> [3] Note that since there are no guarantees on the state of the
+ * properties, a tag handler that had some optional properties set can only be
+ * reused if those properties are set to a new (known) value. This means
+ * that tag handlers can only be reused within the same "AttSet" (set of
+ * attributes that have been set).
+ * <li> Check the TryCatchFinally interface for additional details related
+ * to exception handling and resource management.
+ * </ul>
+ *
+ * <IMG src="doc-files/TagProtocol.gif"/>
+ *
*/
public interface Tag {
@@ -156,8 +170,7 @@
* Invoked by the JSP page implementation object prior to doStartTag().
* <p>
* This value is *not* reset by doEndTag() and must be explicitly reset
- * by a page implementation. Code can assume that setPageContext
- * has been called with the proper values before this point.
+ * by a page implementation.
*
* @param t The parent tag, or null.
*/
@@ -179,13 +192,6 @@
// Actions for basic start/end processing.
-
-
- /**
- * Reset all custom (i.e. not parent, not pageContext) attributes to their
- * default values
- */
- public void resetCustomAttributes();
/**
1.1.1.1.4.3 +3 -3 jakarta-servletapi/src/share/javax/servlet/jsp/tagext/TagLibraryInfo.java
Index: TagLibraryInfo.java
===================================================================
RCS file: /home/cvs/jakarta-servletapi/src/share/javax/servlet/jsp/tagext/TagLibraryInfo.java,v
retrieving revision 1.1.1.1.4.2
retrieving revision 1.1.1.1.4.3
diff -u -r1.1.1.1.4.2 -r1.1.1.1.4.3
--- TagLibraryInfo.java 2000/10/23 18:19:08 1.1.1.1.4.2
+++ TagLibraryInfo.java 2000/10/26 06:28:01 1.1.1.1.4.3
@@ -114,11 +114,11 @@
// ==== methods using the TLD data =======
/**
- * The prefered short name (prefix) as indicated in the TLD.
- * This may be used by authoring tools as the prefered prefix
+ * The preferred short name (prefix) as indicated in the TLD.
+ * This may be used by authoring tools as the preferred prefix
* to use when creating an include directive for this library.
*
- * @returns the prefered short name for the library
+ * @returns the preferred short name for the library
*/
public String getShortName() {
return shortname;
1.1.2.3 +1 -1 jakarta-servletapi/src/share/javax/servlet/jsp/tagext/Attic/TagLibraryValidator.java
Index: TagLibraryValidator.java
===================================================================
RCS file: /home/cvs/jakarta-servletapi/src/share/javax/servlet/jsp/tagext/Attic/TagLibraryValidator.java,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- TagLibraryValidator.java 2000/10/25 19:11:21 1.1.2.2
+++ TagLibraryValidator.java 2000/10/26 06:28:01 1.1.2.3
@@ -66,7 +66,7 @@
* arguments with a tag library.
*
* <p>
- * The JSP container is reponsible for locating an approriate
+ * The JSP container is reponsible for locating an appropriate
* instance of the appropriate subclass by
*
* <ul>
1.1.1.1.4.3 +6 -2 jakarta-servletapi/src/share/javax/servlet/jsp/tagext/TagSupport.java
Index: TagSupport.java
===================================================================
RCS file: /home/cvs/jakarta-servletapi/src/share/javax/servlet/jsp/tagext/TagSupport.java,v
retrieving revision 1.1.1.1.4.2
retrieving revision 1.1.1.1.4.3
diff -u -r1.1.1.1.4.2 -r1.1.1.1.4.3
--- TagSupport.java 2000/10/13 23:13:40 1.1.1.1.4.2
+++ TagSupport.java 2000/10/26 06:28:01 1.1.1.1.4.3
@@ -134,6 +134,7 @@
* Default processing of the start tag, returning SKIP_BODY.
*
* @returns SKIP_BODY
+ *
* @see Tag#doStartTag()
*/
@@ -145,6 +146,7 @@
* Default processing of the end tag returning EVAL_PAGE.
*
* @returns EVAL_PAGE
+ *
* @see Tag#doEndTag()
*/
@@ -157,6 +159,7 @@
* Default processing for a body
*
* @return SKIP_BODY
+ *
* @see IterationTag#doAfterBody()
*/
@@ -175,6 +178,7 @@
/**
* Release state.
+ *
* @see Tag#release()
*/
@@ -184,9 +188,9 @@
/**
* Set the nesting tag of this tag.
- * @see Tag#setParent
*
* @param t The parent Tag.
+ * @see Tag#setParent(Tag)
*/
public void setParent(Tag t) {
@@ -226,9 +230,9 @@
/**
* Set the page context.
- * @see Tag#setPageContext
*
* @param pageContenxt The PageContext.
+ * @see Tag#setPageContext
*/
public void setPageContext(PageContext pageContext) {
1.1.2.3 +11 -8 jakarta-servletapi/src/share/javax/servlet/jsp/tagext/Attic/TagVariableInfo.java
Index: TagVariableInfo.java
===================================================================
RCS file: /home/cvs/jakarta-servletapi/src/share/javax/servlet/jsp/tagext/Attic/TagVariableInfo.java,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- TagVariableInfo.java 2000/10/25 19:30:48 1.1.2.2
+++ TagVariableInfo.java 2000/10/26 06:28:02 1.1.2.3
@@ -73,8 +73,11 @@
/**
* Constructor for TagVariableInfo
*
- * @param
- * @param
+ * @param nameGiven value of <name-given>
+ * @param nameFromAttribute value of <name-from-attribute>
+ * @param className value of <variable-class>
+ * @param declare value of <declare>
+ * @param scope value of <scope>
*/
public TagVariableInfo(
String nameGiven,
@@ -90,7 +93,7 @@
}
/**
- * The body of the <name-given> element
+ * The body of the <name-given> element
*
* @return The variable name as a constant
*/
@@ -100,10 +103,10 @@
}
/**
- * The body of the <name-from-attribute> element.
+ * The body of the <name-from-attribute> element.
* This is the name of an attribute whose (translation-time)
* value will give the name of the variable. One of
- * <name-given> or <name-from-attribute> is required.
+ * <name-given> or <name-from-attribute> is required.
*
* @return The attribute whose value defines the variable name
*/
@@ -113,7 +116,7 @@
}
/**
- * The body of the <variable-class> element.
+ * The body of the <variable-class> element.
*
* @return The name of the class of the variable
*/
@@ -123,7 +126,7 @@
}
/**
- * The body of the <declare> element
+ * The body of the <declare> element
*
* @return Whether the variable is to be declared or not
*/
@@ -133,7 +136,7 @@
}
/**
- * The body of the <scope> element
+ * The body of the <scope> element
*
* @return The scope to give the variable.
*/