cziegeler 2004/07/11 07:00:57
Modified: src/java/org/apache/cocoon/environment Request.java
Log:
Add since attribute
Revision Changes Path
1.9 +72 -68
cocoon-2.1/src/java/org/apache/cocoon/environment/Request.java
Index: Request.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/environment/Request.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- Request.java 11 Jul 2004 13:59:12 -0000 1.8
+++ Request.java 11 Jul 2004 14:00:57 -0000 1.9
@@ -138,73 +138,77 @@
void removeAttribute(String name);
/**
- * Returns the value of the named attribute from the scope
- * as an <code>Object</code>, or <code>null</code> if no attribute
- * of the given name exists.
- *
- * @param name a <code>String</code> specifying the name of
- * the attribute
- * @param scope scope (global or request) of the attribute
- *
- * @return an <code>Object</code> containing the value
- * of the attribute, or <code>null</code> if
- * the attribute does not exist
- *
- */
- Object getAttribute(String name, int scope);
+ * Returns the value of the named attribute from the scope
+ * as an <code>Object</code>, or <code>null</code> if no attribute
+ * of the given name exists.
+ *
+ * @param name a <code>String</code> specifying the name of
+ * the attribute
+ * @param scope scope (global or request) of the attribute
+ *
+ * @return an <code>Object</code> containing the value
+ * of the attribute, or <code>null</code> if
+ * the attribute does not exist
+ *
+ * @since 2.2
+ */
+ Object getAttribute(String name, int scope);
- /**
- * Returns an <code>Enumeration</code> containing the
- * names of the attributes available to this request in the scope.
- * This method returns an empty <code>Enumeration</code>
- * if the request has no attributes available to it.
- *
- * @param scope scope (global or request) of the attribute
- *
- * @return an <code>Enumeration</code> of strings
- * containing the names
- * of the request's attributes
- *
- */
- Enumeration getAttributeNames(int scope);
+ /**
+ * Returns an <code>Enumeration</code> containing the
+ * names of the attributes available to this request in the scope.
+ * This method returns an empty <code>Enumeration</code>
+ * if the request has no attributes available to it.
+ *
+ * @param scope scope (global or request) of the attribute
+ *
+ * @return an <code>Enumeration</code> of strings
+ * containing the names
+ * of the request's attributes
+ *
+ * @since 2.2
+ */
+ Enumeration getAttributeNames(int scope);
- /**
- *
- * Stores an attribute in this request in the scope.
- * Attributes are reset between requests.
- *
- * <p>Attribute names should follow the same conventions as
- * package names. Names beginning with <code>java.*</code>,
- * <code>javax.*</code>, and <code>com.sun.*</code>, are
- * reserved for use by Sun Microsystems.
- *
- *
- * @param name a <code>String</code> specifying
- * the name of the attribute
- * @param o the <code>Object</code> to be
stored
- * @param scope scope (global or request) of the attribute
- *
- */
- void setAttribute(String name, Object o, int scope);
+ /**
+ *
+ * Stores an attribute in this request in the scope.
+ * Attributes are reset between requests.
+ *
+ * <p>Attribute names should follow the same conventions as
+ * package names. Names beginning with <code>java.*</code>,
+ * <code>javax.*</code>, and <code>com.sun.*</code>, are
+ * reserved for use by Sun Microsystems.
+ *
+ *
+ * @param name a <code>String</code> specifying
+ * the name of the attribute
+ * @param o the <code>Object</code> to be
stored
+ * @param scope scope (global or request) of the attribute
+ *
+ * @since 2.2
+ */
+ void setAttribute(String name, Object o, int scope);
- /**
- * Removes an attribute from this request in the scope.
- * This method is not
- * generally needed as attributes only persist as long as the request
- * is being handled.
- *
- * <p>Attribute names should follow the same conventions as
- * package names. Names beginning with <code>java.*</code>,
- * <code>javax.*</code>, and <code>com.sun.*</code>, are
- * reserved for use by Sun Microsystems.
- *
- *
- * @param name a <code>String</code> specifying
- * the name of the attribute to
remove
- * @param scope scope (global or request) of the attribute
- *
- */
- void removeAttribute(String name, int scope);
+ /**
+ * Removes an attribute from this request in the scope.
+ * This method is not
+ * generally needed as attributes only persist as long as the request
+ * is being handled.
+ *
+ * <p>Attribute names should follow the same conventions as
+ * package names. Names beginning with <code>java.*</code>,
+ * <code>javax.*</code>, and <code>com.sun.*</code>, are
+ * reserved for use by Sun Microsystems.
+ *
+ *
+ * @param name a <code>String</code> specifying
+ * the name of the attribute to
remove
+ * @param scope scope (global or request) of the attribute
+ *
+ * @since 2.2
+ */
+ void removeAttribute(String name, int scope);
/**
*
