tomcat-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ma...@apache.org
Subject svn commit: r967140 [2/3] - /tomcat/trunk/java/javax/servlet/
Date Fri, 23 Jul 2010 15:48:54 GMT
Modified: tomcat/trunk/java/javax/servlet/ServletOutputStream.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/ServletOutputStream.java?rev=967140&r1=967139&r2=967140&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/ServletOutputStream.java (original)
+++ tomcat/trunk/java/javax/servlet/ServletOutputStream.java Fri Jul 23 15:48:53 2010
@@ -1,19 +1,19 @@
 /*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements.  See the NOTICE file distributed with
-* this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
-* the License.  You may obtain a copy of the License at
-*
-*     http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package javax.servlet;
 
 import java.io.OutputStream;
@@ -23,343 +23,252 @@ import java.text.MessageFormat;
 import java.util.ResourceBundle;
 
 /**
- * Provides an output stream for sending binary data to the
- * client. A <code>ServletOutputStream</code> object is normally retrieved 
- * via the {@link ServletResponse#getOutputStream} method.
- *
- * <p>This is an abstract class that the servlet container implements.
- * Subclasses of this class
- * must implement the <code>java.io.OutputStream.write(int)</code>
+ * Provides an output stream for sending binary data to the client. A
+ * <code>ServletOutputStream</code> object is normally retrieved via the
+ * {@link ServletResponse#getOutputStream} method.
+ * <p>
+ * This is an abstract class that the servlet container implements. Subclasses
+ * of this class must implement the <code>java.io.OutputStream.write(int)</code>
  * method.
- *
  * 
- * @author 	Various
- * @version 	$Version$
- *
- * @see 	ServletResponse
- *
+ * @author Various
+ * @version $Version$
+ * @see ServletResponse
  */
-
 public abstract class ServletOutputStream extends OutputStream {
 
     private static final String LSTRING_FILE = "javax.servlet.LocalStrings";
-    private static final ResourceBundle lStrings =
-        ResourceBundle.getBundle(LSTRING_FILE);
+    private static final ResourceBundle lStrings = ResourceBundle.getBundle(LSTRING_FILE);
 
-
-    
     /**
-     *
      * Does nothing, because this is an abstract class.
-     *
      */
     protected ServletOutputStream() {
         // NOOP
     }
 
-
     /**
-     * Writes a <code>String</code> to the client, 
-     * without a carriage return-line feed (CRLF) 
-     * character at the end.
-     *
-     *
-     * @param s			the <code>String</code> to send to the client
-     *
-     * @exception IOException 	if an input or output exception occurred
-     *
+     * Writes a <code>String</code> to the client, without a carriage
+     * return-line feed (CRLF) character at the end.
+     * 
+     * @param s
+     *            the <code>String</code> to send to the client
+     * @exception IOException
+     *                if an input or output exception occurred
      */
-
     public void print(String s) throws IOException {
-	if (s==null) s="null";
-	int len = s.length();
-	for (int i = 0; i < len; i++) {
-	    char c = s.charAt (i);
-
-	    //
-	    // XXX NOTE:  This is clearly incorrect for many strings,
-	    // but is the only consistent approach within the current
-	    // servlet framework.  It must suffice until servlet output
-	    // streams properly encode their output.
-	    //
-	    if ((c & 0xff00) != 0) {	// high order byte must be zero
-		String errMsg = lStrings.getString("err.not_iso8859_1");
-		Object[] errArgs = new Object[1];
-		errArgs[0] = new Character(c);
-		errMsg = MessageFormat.format(errMsg, errArgs);
-		throw new CharConversionException(errMsg);
-	    }
-	    write (c);
-	}
+        if (s == null)
+            s = "null";
+        int len = s.length();
+        for (int i = 0; i < len; i++) {
+            char c = s.charAt(i);
+
+            //
+            // XXX NOTE: This is clearly incorrect for many strings,
+            // but is the only consistent approach within the current
+            // servlet framework. It must suffice until servlet output
+            // streams properly encode their output.
+            //
+            if ((c & 0xff00) != 0) { // high order byte must be zero
+                String errMsg = lStrings.getString("err.not_iso8859_1");
+                Object[] errArgs = new Object[1];
+                errArgs[0] = new Character(c);
+                errMsg = MessageFormat.format(errMsg, errArgs);
+                throw new CharConversionException(errMsg);
+            }
+            write(c);
+        }
     }
 
-
-
     /**
-     * Writes a <code>boolean</code> value to the client,
-     * with no carriage return-line feed (CRLF) 
-     * character at the end.
-     *
-     * @param b			the <code>boolean</code> value 
-     *				to send to the client
-     *
-     * @exception IOException 	if an input or output exception occurred
-     *
+     * Writes a <code>boolean</code> value to the client, with no carriage
+     * return-line feed (CRLF) character at the end.
+     * 
+     * @param b
+     *            the <code>boolean</code> value to send to the client
+     * @exception IOException
+     *                if an input or output exception occurred
      */
-
     public void print(boolean b) throws IOException {
-	String msg;
-	if (b) {
-	    msg = lStrings.getString("value.true");
-	} else {
-	    msg = lStrings.getString("value.false");
-	}
-	print(msg);
+        String msg;
+        if (b) {
+            msg = lStrings.getString("value.true");
+        } else {
+            msg = lStrings.getString("value.false");
+        }
+        print(msg);
     }
 
-
-
     /**
-     * Writes a character to the client,
-     * with no carriage return-line feed (CRLF) 
-     * at the end.
-     *
-     * @param c			the character to send to the client
-     *
-     * @exception IOException 	if an input or output exception occurred
-     *
+     * Writes a character to the client, with no carriage return-line feed
+     * (CRLF) at the end.
+     * 
+     * @param c
+     *            the character to send to the client
+     * @exception IOException
+     *                if an input or output exception occurred
      */
-
     public void print(char c) throws IOException {
-	print(String.valueOf(c));
+        print(String.valueOf(c));
     }
 
-
-
-
     /**
-     *
-     * Writes an int to the client,
-     * with no carriage return-line feed (CRLF) 
-     * at the end.
-     *
-     * @param i			the int to send to the client
-     *
-     * @exception IOException 	if an input or output exception occurred
-     *
-     */  
-
+     * Writes an int to the client, with no carriage return-line feed (CRLF) at
+     * the end.
+     * 
+     * @param i
+     *            the int to send to the client
+     * @exception IOException
+     *                if an input or output exception occurred
+     */
     public void print(int i) throws IOException {
-	print(String.valueOf(i));
+        print(String.valueOf(i));
     }
 
-
-
- 
     /**
+     * Writes a <code>long</code> value to the client, with no carriage
+     * return-line feed (CRLF) at the end.
      * 
-     * Writes a <code>long</code> value to the client,
-     * with no carriage return-line feed (CRLF) at the end.
-     *
-     * @param l			the <code>long</code> value 
-     *				to send to the client
-     *
-     * @exception IOException 	if an input or output exception 
-     *				occurred
-     * 
+     * @param l
+     *            the <code>long</code> value to send to the client
+     * @exception IOException
+     *                if an input or output exception occurred
      */
-
     public void print(long l) throws IOException {
-	print(String.valueOf(l));
+        print(String.valueOf(l));
     }
 
-
-
     /**
-     *
-     * Writes a <code>float</code> value to the client,
-     * with no carriage return-line feed (CRLF) at the end.
-     *
-     * @param f			the <code>float</code> value
-     *				to send to the client
-     *
-     * @exception IOException	if an input or output exception occurred
-     *
-     *
+     * Writes a <code>float</code> value to the client, with no carriage
+     * return-line feed (CRLF) at the end.
+     * 
+     * @param f
+     *            the <code>float</code> value to send to the client
+     * @exception IOException
+     *                if an input or output exception occurred
      */
-
     public void print(float f) throws IOException {
-	print(String.valueOf(f));
+        print(String.valueOf(f));
     }
 
-
-
     /**
-     *
-     * Writes a <code>double</code> value to the client,
-     * with no carriage return-line feed (CRLF) at the end.
+     * Writes a <code>double</code> value to the client, with no carriage
+     * return-line feed (CRLF) at the end.
      * 
-     * @param d			the <code>double</code> value
-     *				to send to the client
-     *
-     * @exception IOException 	if an input or output exception occurred
-     *
+     * @param d
+     *            the <code>double</code> value to send to the client
+     * @exception IOException
+     *                if an input or output exception occurred
      */
-
     public void print(double d) throws IOException {
-	print(String.valueOf(d));
+        print(String.valueOf(d));
     }
 
-
-
     /**
-     * Writes a carriage return-line feed (CRLF)
-     * to the client.
-     *
-     *
-     *
-     * @exception IOException 	if an input or output exception occurred
-     *
+     * Writes a carriage return-line feed (CRLF) to the client.
+     * 
+     * @exception IOException
+     *                if an input or output exception occurred
      */
-
     public void println() throws IOException {
-	print("\r\n");
+        print("\r\n");
     }
 
-
-
     /**
-     * Writes a <code>String</code> to the client, 
-     * followed by a carriage return-line feed (CRLF).
-     *
-     *
-     * @param s			the <code>String</code> to write to the client
-     *
-     * @exception IOException 	if an input or output exception occurred
-     *
+     * Writes a <code>String</code> to the client, followed by a carriage
+     * return-line feed (CRLF).
+     * 
+     * @param s
+     *            the <code>String</code> to write to the client
+     * @exception IOException
+     *                if an input or output exception occurred
      */
-
     public void println(String s) throws IOException {
-	print(s);
-	println();
+        print(s);
+        println();
     }
 
-
-
-
     /**
-     *
-     * Writes a <code>boolean</code> value to the client, 
-     * followed by a 
-     * carriage return-line feed (CRLF).
-     *
-     *
-     * @param b			the <code>boolean</code> value 
-     *				to write to the client
-     *
-     * @exception IOException 	if an input or output exception occurred
-     *
+     * Writes a <code>boolean</code> value to the client, followed by a carriage
+     * return-line feed (CRLF).
+     * 
+     * @param b
+     *            the <code>boolean</code> value to write to the client
+     * @exception IOException
+     *                if an input or output exception occurred
      */
-
     public void println(boolean b) throws IOException {
-	print(b);
-	println();
+        print(b);
+        println();
     }
 
-
-
     /**
-     *
-     * Writes a character to the client, followed by a carriage
-     * return-line feed (CRLF).
-     *
-     * @param c			the character to write to the client
-     *
-     * @exception IOException 	if an input or output exception occurred
-     *
+     * Writes a character to the client, followed by a carriage return-line feed
+     * (CRLF).
+     * 
+     * @param c
+     *            the character to write to the client
+     * @exception IOException
+     *                if an input or output exception occurred
      */
-
     public void println(char c) throws IOException {
-	print(c);
-	println();
+        print(c);
+        println();
     }
 
-
-
     /**
-     *
-     * Writes an int to the client, followed by a 
-     * carriage return-line feed (CRLF) character.
-     *
-     *
-     * @param i			the int to write to the client
-     *
-     * @exception IOException 	if an input or output exception occurred
-     *
+     * Writes an int to the client, followed by a carriage return-line feed
+     * (CRLF) character.
+     * 
+     * @param i
+     *            the int to write to the client
+     * @exception IOException
+     *                if an input or output exception occurred
      */
-
     public void println(int i) throws IOException {
-	print(i);
-	println();
+        print(i);
+        println();
     }
 
-
-
-    /**  
-     *
-     * Writes a <code>long</code> value to the client, followed by a 
-     * carriage return-line feed (CRLF).
-     *
-     *
-     * @param l			the <code>long</code> value to write to the client
-     *
-     * @exception IOException 	if an input or output exception occurred
-     *
-     */  
-
+    /**
+     * Writes a <code>long</code> value to the client, followed by a carriage
+     * return-line feed (CRLF).
+     * 
+     * @param l
+     *            the <code>long</code> value to write to the client
+     * @exception IOException
+     *                if an input or output exception occurred
+     */
     public void println(long l) throws IOException {
-	print(l);
-	println();
+        print(l);
+        println();
     }
 
-
-
     /**
-     *
-     * Writes a <code>float</code> value to the client, 
-     * followed by a carriage return-line feed (CRLF).
-     *
-     * @param f			the <code>float</code> value 
-     *				to write to the client
-     *
-     *
-     * @exception IOException 	if an input or output exception 
-     *				occurred
-     *
+     * Writes a <code>float</code> value to the client, followed by a carriage
+     * return-line feed (CRLF).
+     * 
+     * @param f
+     *            the <code>float</code> value to write to the client
+     * @exception IOException
+     *                if an input or output exception occurred
      */
-
     public void println(float f) throws IOException {
-	print(f);
-	println();
+        print(f);
+        println();
     }
 
-
-
     /**
-     *
-     * Writes a <code>double</code> value to the client, 
-     * followed by a carriage return-line feed (CRLF).
-     *
-     *
-     * @param d			the <code>double</code> value
-     *				to write to the client
-     *
-     * @exception IOException 	if an input or output exception occurred
-     *
+     * Writes a <code>double</code> value to the client, followed by a carriage
+     * return-line feed (CRLF).
+     * 
+     * @param d
+     *            the <code>double</code> value to write to the client
+     * @exception IOException
+     *                if an input or output exception occurred
      */
-
     public void println(double d) throws IOException {
-	print(d);
-	println();
+        print(d);
+        println();
     }
 }

Modified: tomcat/trunk/java/javax/servlet/ServletRequest.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/ServletRequest.java?rev=967140&r1=967139&r2=967140&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/ServletRequest.java (original)
+++ tomcat/trunk/java/javax/servlet/ServletRequest.java Fri Jul 23 15:48:53 2010
@@ -1,19 +1,19 @@
 /*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements.  See the NOTICE file distributed with
-* this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
-* the License.  You may obtain a copy of the License at
-*
-*     http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package javax.servlet;
 
 import java.io.BufferedReader;
@@ -22,637 +22,456 @@ import java.util.Enumeration;
 import java.util.Locale;
 import java.util.Map;
 
-
-
 /**
- * Defines an object to provide client request information to a servlet.  The
- * servlet container creates a <code>ServletRequest</code> object and passes
- * it as an argument to the servlet's <code>service</code> method.
- *
- * <p>A <code>ServletRequest</code> object provides data including
- * parameter name and values, attributes, and an input stream.
- * Interfaces that extend <code>ServletRequest</code> can provide
- * additional protocol-specific data (for example, HTTP data is
- * provided by {@link javax.servlet.http.HttpServletRequest}.
+ * Defines an object to provide client request information to a servlet. The
+ * servlet container creates a <code>ServletRequest</code> object and passes it
+ * as an argument to the servlet's <code>service</code> method.
+ * <p>
+ * A <code>ServletRequest</code> object provides data including parameter name
+ * and values, attributes, and an input stream. Interfaces that extend
+ * <code>ServletRequest</code> can provide additional protocol-specific data
+ * (for example, HTTP data is provided by
+ * {@link javax.servlet.http.HttpServletRequest}.
  * 
- * @author 	Various
- * @version 	$Version$
- *
- * @see 	javax.servlet.http.HttpServletRequest
- *
+ * @author Various
+ * @version $Version$
+ * @see javax.servlet.http.HttpServletRequest
  */
-
 public interface ServletRequest {
 
-
-
-
     /**
-     *
-     * Returns the value of the named attribute as an <code>Object</code>,
-     * or <code>null</code> if no attribute of the given name exists. 
-     *
-     * <p> Attributes can be set two ways.  The servlet container may set
-     * attributes to make available custom information about a request.
-     * For example, for requests made using HTTPS, the attribute
+     * Returns the value of the named attribute as an <code>Object</code>, or
+     * <code>null</code> if no attribute of the given name exists.
+     * <p>
+     * Attributes can be set two ways. The servlet container may set attributes
+     * to make available custom information about a request. For example, for
+     * requests made using HTTPS, the attribute
      * <code>javax.servlet.request.X509Certificate</code> can be used to
-     * retrieve information on the certificate of the client.  Attributes
-     * can also be set programatically using 
-     * {@link ServletRequest#setAttribute}.  This allows information to be
-     * embedded into a request before a {@link RequestDispatcher} call.
-     *
-     * <p>Attribute names should follow the same conventions as package
-     * names. This specification reserves names matching <code>java.*</code>,
-     * <code>javax.*</code>, and <code>sun.*</code>. 
-     *
-     * @param name	a <code>String</code> specifying the name of 
-     *			the attribute
-     *
-     * @return		an <code>Object</code> containing the value 
-     *			of the attribute, or <code>null</code> if
-     *			the attribute does not exist
-     *
+     * retrieve information on the certificate of the client. Attributes can
+     * also be set programatically using {@link ServletRequest#setAttribute}.
+     * This allows information to be embedded into a request before a
+     * {@link RequestDispatcher} call.
+     * <p>
+     * Attribute names should follow the same conventions as package names. This
+     * specification reserves names matching <code>java.*</code>,
+     * <code>javax.*</code>, and <code>sun.*</code>.
+     * 
+     * @param name
+     *            a <code>String</code> specifying the name of the attribute
+     * @return an <code>Object</code> containing the value of the attribute, or
+     *         <code>null</code> if the attribute does not exist
      */
-
     public Object getAttribute(String name);
-    
-    
 
     /**
-     * Returns an <code>Enumeration</code> containing the
-     * names of the attributes available to this request. 
-     * This method returns an empty <code>Enumeration</code>
-     * if the request has no attributes available to it.
-     * 
-     *
-     * @return		an <code>Enumeration</code> of strings 
-     *			containing the names 
-     * 			of the request's attributes
-     *
+     * Returns an <code>Enumeration</code> containing the names of the
+     * attributes available to this request. This method returns an empty
+     * <code>Enumeration</code> if the request has no attributes available to
+     * it.
+     * 
+     * @return an <code>Enumeration</code> of strings containing the names of the
+     *         request's attributes
      */
-
     public Enumeration<String> getAttributeNames();
-    
-    
-    
-    
+
     /**
      * Returns the name of the character encoding used in the body of this
-     * request. This method returns <code>null</code> if the request
-     * does not specify a character encoding
+     * request. This method returns <code>null</code> if the request does not
+     * specify a character encoding
      * 
-     *
-     * @return		a <code>String</code> containing the name of 
-     *			the character encoding, or <code>null</code>
-     *			if the request does not specify a character encoding
-     *
+     * @return a <code>String</code> containing the name of the character
+     *         encoding, or <code>null</code> if the request does not specify a
+     *         character encoding
      */
-
     public String getCharacterEncoding();
 
- /**
+    /**
      * Overrides the name of the character encoding used in the body of this
      * request. This method must be called prior to reading request parameters
      * or reading input using getReader().
      * 
-     *
-     * @param env	a <code>String</code> containing the name of 
-     *			the character encoding.
-     * @throws		java.io.UnsupportedEncodingException if this is not a valid encoding
-     */
-
-    public void setCharacterEncoding(String env) throws java.io.UnsupportedEncodingException;
-
-    
-    
-    
-    
-    /**
-     * Returns the length, in bytes, of the request body 
-     * and made available by the input stream, or -1 if the
-     * length is not known. For HTTP servlets, same as the value
-     * of the CGI variable CONTENT_LENGTH.
-     *
-     * @return		an integer containing the length of the 
-     * 			request body or -1 if the length is not known
-     *
+     * @param env
+     *            a <code>String</code> containing the name of the character
+     *            encoding.
+     * @throws java.io.UnsupportedEncodingException
+     *             if this is not a valid encoding
+     */
+    public void setCharacterEncoding(String env)
+            throws java.io.UnsupportedEncodingException;
+
+    /**
+     * Returns the length, in bytes, of the request body and made available by
+     * the input stream, or -1 if the length is not known. For HTTP servlets,
+     * same as the value of the CGI variable CONTENT_LENGTH.
+     * 
+     * @return an integer containing the length of the request body or -1 if the
+     *         length is not known
      */
-
     public int getContentLength();
-    
-    
-    
 
     /**
-     * Returns the MIME type of the body of the request, or 
-     * <code>null</code> if the type is not known. For HTTP servlets, 
-     * same as the value of the CGI variable CONTENT_TYPE.
-     *
-     * @return		a <code>String</code> containing the name 
-     *			of the MIME type of 
-     * 			the request, or null if the type is not known
-     *
+     * Returns the MIME type of the body of the request, or <code>null</code> if
+     * the type is not known. For HTTP servlets, same as the value of the CGI
+     * variable CONTENT_TYPE.
+     * 
+     * @return a <code>String</code> containing the name of the MIME type of the
+     *         request, or null if the type is not known
      */
-
     public String getContentType();
-    
-    
-    
-
-    /**
-     * Retrieves the body of the request as binary data using
-     * a {@link ServletInputStream}.  Either this method or 
-     * {@link #getReader} may be called to read the body, not both.
-     *
-     * @return			a {@link ServletInputStream} object containing
-     * 				the body of the request
-     *
-     * @exception IllegalStateException  if the {@link #getReader} method
-     * 					 has already been called for this request
-     *
-     * @exception IOException    	if an input or output exception occurred
-     *
-     */
-
-    public ServletInputStream getInputStream() throws IOException; 
-     
-    
-    
-
-    /**
-     * Returns the value of a request parameter as a <code>String</code>,
-     * or <code>null</code> if the parameter does not exist. Request parameters
-     * are extra information sent with the request.  For HTTP servlets,
-     * parameters are contained in the query string or posted form data.
-     *
-     * <p>You should only use this method when you are sure the
-     * parameter has only one value. If the parameter might have
-     * more than one value, use {@link #getParameterValues}.
-     *
-     * <p>If you use this method with a multivalued
-     * parameter, the value returned is equal to the first value
-     * in the array returned by <code>getParameterValues</code>.
-     *
-     * <p>If the parameter data was sent in the request body, such as occurs
-     * with an HTTP POST request, then reading the body directly via {@link
-     * #getInputStream} or {@link #getReader} can interfere
-     * with the execution of this method.
-     *
-     * @param name 	a <code>String</code> specifying the 
-     *			name of the parameter
-     *
-     * @return		a <code>String</code> representing the 
-     *			single value of the parameter
-     *
-     * @see 		#getParameterValues
-     *
-     */
 
+    /**
+     * Retrieves the body of the request as binary data using a
+     * {@link ServletInputStream}. Either this method or {@link #getReader} may
+     * be called to read the body, not both.
+     * 
+     * @return a {@link ServletInputStream} object containing the body of the
+     *         request
+     * @exception IllegalStateException
+     *                if the {@link #getReader} method has already been called
+     *                for this request
+     * @exception IOException
+     *                if an input or output exception occurred
+     */
+    public ServletInputStream getInputStream() throws IOException;
+
+    /**
+     * Returns the value of a request parameter as a <code>String</code>, or
+     * <code>null</code> if the parameter does not exist. Request parameters are
+     * extra information sent with the request. For HTTP servlets, parameters
+     * are contained in the query string or posted form data.
+     * <p>
+     * You should only use this method when you are sure the parameter has only
+     * one value. If the parameter might have more than one value, use
+     * {@link #getParameterValues}.
+     * <p>
+     * If you use this method with a multivalued parameter, the value returned
+     * is equal to the first value in the array returned by
+     * <code>getParameterValues</code>.
+     * <p>
+     * If the parameter data was sent in the request body, such as occurs with
+     * an HTTP POST request, then reading the body directly via
+     * {@link #getInputStream} or {@link #getReader} can interfere with the
+     * execution of this method.
+     * 
+     * @param name
+     *            a <code>String</code> specifying the name of the parameter
+     * @return a <code>String</code> representing the single value of the
+     *         parameter
+     * @see #getParameterValues
+     */
     public String getParameter(String name);
-    
-    
-    
-
-    /**
-     *
-     * Returns an <code>Enumeration</code> of <code>String</code>
-     * objects containing the names of the parameters contained
-     * in this request. If the request has 
-     * no parameters, the method returns an 
-     * empty <code>Enumeration</code>. 
-     *
-     * @return		an <code>Enumeration</code> of <code>String</code>
-     *			objects, each <code>String</code> containing
-     * 			the name of a request parameter; or an 
-     *			empty <code>Enumeration</code> if the
-     *			request has no parameters
-     *
+
+    /**
+     * Returns an <code>Enumeration</code> of <code>String</code> objects
+     * containing the names of the parameters contained in this request. If the
+     * request has no parameters, the method returns an empty
+     * <code>Enumeration</code>.
+     * 
+     * @return an <code>Enumeration</code> of <code>String</code> objects, each
+     *         <code>String</code> containing the name of a request parameter;
+     *         or an empty <code>Enumeration</code> if the request has no
+     *         parameters
      */
-     
     public Enumeration<String> getParameterNames();
-    
-    
-    
-
-    /**
-     * Returns an array of <code>String</code> objects containing 
-     * all of the values the given request parameter has, or 
-     * <code>null</code> if the parameter does not exist.
-     *
-     * <p>If the parameter has a single value, the array has a length
-     * of 1.
-     *
-     * @param name	a <code>String</code> containing the name of 
-     *			the parameter whose value is requested
-     *
-     * @return		an array of <code>String</code> objects 
-     *			containing the parameter's values
-     *
-     * @see		#getParameter
-     *
-     */
 
+    /**
+     * Returns an array of <code>String</code> objects containing all of the
+     * values the given request parameter has, or <code>null</code> if the
+     * parameter does not exist.
+     * <p>
+     * If the parameter has a single value, the array has a length of 1.
+     * 
+     * @param name
+     *            a <code>String</code> containing the name of the parameter
+     *            whose value is requested
+     * @return an array of <code>String</code> objects containing the parameter's
+     *         values
+     * @see #getParameter
+     */
     public String[] getParameterValues(String name);
- 
-    /** Returns a java.util.Map of the parameters of this request.
-     * Request parameters
-     * are extra information sent with the request.  For HTTP servlets,
-     * parameters are contained in the query string or posted form data.
-     *
-     * @return an immutable java.util.Map containing parameter names as 
-     * keys and parameter values as map values. The keys in the parameter
-     * map are of type String. The values in the parameter map are of type
-     * String array.
-     *
-     */
-
-    public Map<String,String[]> getParameterMap();
-    
-    
-
-    /**
-     * Returns the name and version of the protocol the request uses
-     * in the form <i>protocol/majorVersion.minorVersion</i>, for 
-     * example, HTTP/1.1. For HTTP servlets, the value
-     * returned is the same as the value of the CGI variable 
-     * <code>SERVER_PROTOCOL</code>.
-     *
-     * @return		a <code>String</code> containing the protocol 
-     *			name and version number
-     *
+
+    /**
+     * Returns a java.util.Map of the parameters of this request. Request
+     * parameters are extra information sent with the request. For HTTP
+     * servlets, parameters are contained in the query string or posted form
+     * data.
+     * 
+     * @return an immutable java.util.Map containing parameter names as keys and
+     *         parameter values as map values. The keys in the parameter map are
+     *         of type String. The values in the parameter map are of type
+     *         String array.
+     */
+    public Map<String, String[]> getParameterMap();
+
+    /**
+     * Returns the name and version of the protocol the request uses in the form
+     * <i>protocol/majorVersion.minorVersion</i>, for example, HTTP/1.1. For
+     * HTTP servlets, the value returned is the same as the value of the CGI
+     * variable <code>SERVER_PROTOCOL</code>.
+     * 
+     * @return a <code>String</code> containing the protocol name and version
+     *         number
      */
-    
     public String getProtocol();
-    
-    
-    
 
     /**
-     * Returns the name of the scheme used to make this request, 
-     * for example,
-     * <code>http</code>, <code>https</code>, or <code>ftp</code>.
-     * Different schemes have different rules for constructing URLs,
-     * as noted in RFC 1738.
-     *
-     * @return		a <code>String</code> containing the name 
-     *			of the scheme used to make this request
-     *
+     * Returns the name of the scheme used to make this request, for example,
+     * <code>http</code>, <code>https</code>, or <code>ftp</code>. Different
+     * schemes have different rules for constructing URLs, as noted in RFC 1738.
+     * 
+     * @return a <code>String</code> containing the name of the scheme used to
+     *         make this request
      */
-
     public String getScheme();
-    
-    
-    
 
     /**
-     * Returns the host name of the server to which the request was sent.
-     * It is the value of the part before ":" in the <code>Host</code>
-     * header value, if any, or the resolved server name, or the server IP address.
-     *
-     * @return		a <code>String</code> containing the name 
-     *			of the server
+     * Returns the host name of the server to which the request was sent. It is
+     * the value of the part before ":" in the <code>Host</code> header value,
+     * if any, or the resolved server name, or the server IP address.
+     * 
+     * @return a <code>String</code> containing the name of the server
      */
-
     public String getServerName();
-    
-    
-    
 
     /**
-     * Returns the port number to which the request was sent.
-     * It is the value of the part after ":" in the <code>Host</code>
-     * header value, if any, or the server port where the client connection
-     * was accepted on.
-     *
-     * @return		an integer specifying the port number
-     *
+     * Returns the port number to which the request was sent. It is the value of
+     * the part after ":" in the <code>Host</code> header value, if any, or the
+     * server port where the client connection was accepted on.
+     * 
+     * @return an integer specifying the port number
      */
-
     public int getServerPort();
-    
-    
-    
-    /**
-     * Retrieves the body of the request as character data using
-     * a <code>BufferedReader</code>.  The reader translates the character
-     * data according to the character encoding used on the body.
-     * Either this method or {@link #getInputStream} may be called to read the
-     * body, not both.
-     * 
-     *
-     * @return					a <code>BufferedReader</code>
-     *						containing the body of the request	
-     *
-     * @exception UnsupportedEncodingException 	if the character set encoding
-     * 						used is not supported and the 
-     *						text cannot be decoded
-     *
-     * @exception IllegalStateException   	if {@link #getInputStream} method
-     * 						has been called on this request
-     *
-     * @exception IOException  			if an input or output exception occurred
-     *
-     * @see 					#getInputStream
-     *
-     */
 
+    /**
+     * Retrieves the body of the request as character data using a
+     * <code>BufferedReader</code>. The reader translates the character data
+     * according to the character encoding used on the body. Either this method
+     * or {@link #getInputStream} may be called to read the body, not both.
+     * 
+     * @return a <code>BufferedReader</code> containing the body of the request
+     * @exception UnsupportedEncodingException
+     *                if the character set encoding used is not supported and
+     *                the text cannot be decoded
+     * @exception IllegalStateException
+     *                if {@link #getInputStream} method has been called on this
+     *                request
+     * @exception IOException
+     *                if an input or output exception occurred
+     * @see #getInputStream
+     */
     public BufferedReader getReader() throws IOException;
-    
-    
-    
 
     /**
-     * Returns the Internet Protocol (IP) address of the client 
-     * or last proxy that sent the request.
-     * For HTTP servlets, same as the value of the 
-     * CGI variable <code>REMOTE_ADDR</code>.
-     *
-     * @return		a <code>String</code> containing the 
-     *			IP address of the client that sent the request
-     *
+     * Returns the Internet Protocol (IP) address of the client or last proxy
+     * that sent the request. For HTTP servlets, same as the value of the CGI
+     * variable <code>REMOTE_ADDR</code>.
+     * 
+     * @return a <code>String</code> containing the IP address of the client
+     *         that sent the request
      */
-    
     public String getRemoteAddr();
-    
-    
-    
 
     /**
-     * Returns the fully qualified name of the client
-     * or the last proxy that sent the request.
-     * If the engine cannot or chooses not to resolve the hostname 
-     * (to improve performance), this method returns the dotted-string form of 
-     * the IP address. For HTTP servlets, same as the value of the CGI variable 
-     * <code>REMOTE_HOST</code>.
-     *
-     * @return		a <code>String</code> containing the fully 
-     *			qualified name of the client
-     *
+     * Returns the fully qualified name of the client or the last proxy that
+     * sent the request. If the engine cannot or chooses not to resolve the
+     * hostname (to improve performance), this method returns the dotted-string
+     * form of the IP address. For HTTP servlets, same as the value of the CGI
+     * variable <code>REMOTE_HOST</code>.
+     * 
+     * @return a <code>String</code> containing the fully qualified name of the
+     *         client
      */
-
     public String getRemoteHost();
-    
-    
-    
-
-    /**
-     *
-     * Stores an attribute in this request.
-     * Attributes are reset between requests.  This method is most
-     * often used in conjunction with {@link RequestDispatcher}.
-     *
-     * <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.
-     *<br> If the object passed in is null, the effect is the same as
-     * calling {@link #removeAttribute}.
-     * <br> It is warned that when the request is dispatched from the
-     * servlet resides in a different web application by
-     * <code>RequestDispatcher</code>, the object set by this method
-     * may not be correctly retrieved in the caller servlet.
-     *
-     *
-     * @param name			a <code>String</code> specifying 
-     *					the name of the attribute
-     *
-     * @param o				the <code>Object</code> to be stored
-     *
-     */
 
-    public void setAttribute(String name, Object o);
-    
-    
-    
-
-    /**
-     *
-     * Removes an attribute from this request.  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
-     *
+    /**
+     * Stores an attribute in this request. Attributes are reset between
+     * requests. This method is most often used in conjunction with
+     * {@link RequestDispatcher}.
+     * <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. <br>
+     * If the object passed in is null, the effect is the same as calling
+     * {@link #removeAttribute}. <br>
+     * It is warned that when the request is dispatched from the servlet resides
+     * in a different web application by <code>RequestDispatcher</code>, the
+     * object set by this method may not be correctly retrieved in the caller
+     * servlet.
+     * 
+     * @param name
+     *            a <code>String</code> specifying the name of the attribute
+     * @param o
+     *            the <code>Object</code> to be stored
      */
+    public void setAttribute(String name, Object o);
 
+    /**
+     * Removes an attribute from this request. 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
+     */
     public void removeAttribute(String name);
-    
-    
-    
 
     /**
-     *
-     * Returns the preferred <code>Locale</code> that the client will 
-     * accept content in, based on the Accept-Language header.
-     * If the client request doesn't provide an Accept-Language header,
-     * this method returns the default locale for the server.
-     *
-     *
-     * @return		the preferred <code>Locale</code> for the client
-     *
+     * Returns the preferred <code>Locale</code> that the client will accept
+     * content in, based on the Accept-Language header. If the client request
+     * doesn't provide an Accept-Language header, this method returns the
+     * default locale for the server.
+     * 
+     * @return the preferred <code>Locale</code> for the client
      */
-
     public Locale getLocale();
-    
-    
-    
 
     /**
-     *
      * Returns an <code>Enumeration</code> of <code>Locale</code> objects
      * indicating, in decreasing order starting with the preferred locale, the
      * locales that are acceptable to the client based on the Accept-Language
-     * header.
-     * If the client request doesn't provide an Accept-Language header,
-     * this method returns an <code>Enumeration</code> containing one 
+     * header. If the client request doesn't provide an Accept-Language header,
+     * this method returns an <code>Enumeration</code> containing one
      * <code>Locale</code>, the default locale for the server.
-     *
-     *
-     * @return		an <code>Enumeration</code> of preferred 
-     *                  <code>Locale</code> objects for the client
-     *
+     * 
+     * @return an <code>Enumeration</code> of preferred <code>Locale</code>
+     *         objects for the client
      */
-
     public Enumeration<Locale> getLocales();
-    
-    
-    
 
     /**
-     *
-     * Returns a boolean indicating whether this request was made using a
-     * secure channel, such as HTTPS.
-     *
-     *
-     * @return		a boolean indicating if the request was made using a
-     *                  secure channel
-     *
+     * Returns a boolean indicating whether this request was made using a secure
+     * channel, such as HTTPS.
+     * 
+     * @return a boolean indicating if the request was made using a secure
+     *         channel
      */
-
     public boolean isSecure();
-    
-    
-    
-
-    /**
-     *
-     * Returns a {@link RequestDispatcher} object that acts as a wrapper for
-     * the resource located at the given path.  
-     * A <code>RequestDispatcher</code> object can be used to forward
-     * a request to the resource or to include the resource in a response.
-     * The resource can be dynamic or static.
-     *
-     * <p>The pathname specified may be relative, although it cannot extend
-     * outside the current servlet context.  If the path begins with 
-     * a "/" it is interpreted as relative to the current context root.  
-     * This method returns <code>null</code> if the servlet container
-     * cannot return a <code>RequestDispatcher</code>.
-     *
-     * <p>The difference between this method and {@link
-     * ServletContext#getRequestDispatcher} is that this method can take a
-     * relative path.
-     *
-     * @param path      a <code>String</code> specifying the pathname
-     *                  to the resource. If it is relative, it must be
-     *                  relative against the current servlet.
-     *
-     * @return          a <code>RequestDispatcher</code> object
-     *                  that acts as a wrapper for the resource
-     *                  at the specified path, or <code>null</code>
-     *                  if the servlet container cannot return a
-     *                  <code>RequestDispatcher</code>
-     *
-     * @see             RequestDispatcher
-     * @see             ServletContext#getRequestDispatcher
-     *
-     */
 
+    /**
+     * Returns a {@link RequestDispatcher} object that acts as a wrapper for the
+     * resource located at the given path. A <code>RequestDispatcher</code>
+     * object can be used to forward a request to the resource or to include the
+     * resource in a response. The resource can be dynamic or static.
+     * <p>
+     * The pathname specified may be relative, although it cannot extend outside
+     * the current servlet context. If the path begins with a "/" it is
+     * interpreted as relative to the current context root. This method returns
+     * <code>null</code> if the servlet container cannot return a
+     * <code>RequestDispatcher</code>.
+     * <p>
+     * The difference between this method and
+     * {@link ServletContext#getRequestDispatcher} is that this method can take
+     * a relative path.
+     * 
+     * @param path
+     *            a <code>String</code> specifying the pathname to the resource.
+     *            If it is relative, it must be relative against the current
+     *            servlet.
+     * @return a <code>RequestDispatcher</code> object that acts as a wrapper for
+     *         the resource at the specified path, or <code>null</code> if the
+     *         servlet container cannot return a <code>RequestDispatcher</code>
+     * @see RequestDispatcher
+     * @see ServletContext#getRequestDispatcher
+     */
     public RequestDispatcher getRequestDispatcher(String path);
-    
-    
-    
 
     /**
-     * @deprecated 	As of Version 2.1 of the Java Servlet API,
-     * 			use {@link ServletContext#getRealPath} instead.
+     * @deprecated As of Version 2.1 of the Java Servlet API, use
+     *             {@link ServletContext#getRealPath} instead.
      */
-    @SuppressWarnings("dep-ann") // Spec API does not use @Deprecated
+    @SuppressWarnings("dep-ann")
+    // Spec API does not use @Deprecated
     public String getRealPath(String path);
-    
-    
+
     /**
-     * Returns the Internet Protocol (IP) source port of the client
-     * or last proxy that sent the request.
-     *
-     * @return	an integer specifying the port number
-     *
+     * Returns the Internet Protocol (IP) source port of the client or last
+     * proxy that sent the request.
+     * 
+     * @return an integer specifying the port number
      * @since 2.4
-     */    
+     */
     public int getRemotePort();
 
-
     /**
-     * Returns the host name of the Internet Protocol (IP) interface on
-     * which the request was received.
-     *
-     * @return	a <code>String</code> containing the host
-     *		name of the IP on which the request was received.
-     *
+     * Returns the host name of the Internet Protocol (IP) interface on which
+     * the request was received.
+     * 
+     * @return a <code>String</code> containing the host name of the IP on which
+     *         the request was received.
      * @since 2.4
      */
     public String getLocalName();
 
     /**
-     * Returns the Internet Protocol (IP) address of the interface on
-     * which the request  was received.
-     *
-     * @return	a <code>String</code> containing the
-     *		IP address on which the request was received. 
-     *
+     * Returns the Internet Protocol (IP) address of the interface on which the
+     * request was received.
+     * 
+     * @return a <code>String</code> containing the IP address on which the
+     *         request was received.
      * @since 2.4
-     *
-     */       
+     */
     public String getLocalAddr();
 
-
     /**
-     * Returns the Internet Protocol (IP) port number of the interface
-     * on which the request was received.
-     *
+     * Returns the Internet Protocol (IP) port number of the interface on which
+     * the request was received.
+     * 
      * @return an integer specifying the port number
-     *
      * @since 2.4
      */
     public int getLocalPort();
 
     /**
-     * 
      * @return
-     * @since Servlet 3.0
-     * TODO SERVLET3 - Add comments
+     * @since Servlet 3.0 TODO SERVLET3 - Add comments
      */
     public ServletContext getServletContext();
-    
+
     /**
-     * 
      * @return
-     * @throws java.lang.IllegalStateException  If async is not supported for
-     *                                          this request
-     * @since Servlet 3.0
-     * TODO SERVLET3 - Add comments
+     * @throws java.lang.IllegalStateException
+     *             If async is not supported for this request
+     * @since Servlet 3.0 TODO SERVLET3 - Add comments
      */
     public AsyncContext startAsync();
-    
+
     /**
-     * 
      * @param servletRequest
      * @param servletResponse
      * @return
      * @throws java.lang.IllegalStateException
-     * @since Servlet 3.0
-     * TODO SERVLET3 - Add comments
+     * @since Servlet 3.0 TODO SERVLET3 - Add comments
      */
     public AsyncContext startAsync(ServletRequest servletRequest,
             ServletResponse servletResponse);
-    
+
     /**
-     * 
      * @return
-     * @since Servlet 3.0
-     * TODO SERVLET3 - Add comments
+     * @since Servlet 3.0 TODO SERVLET3 - Add comments
      */
     public boolean isAsyncStarted();
-    
+
     /**
-     * 
      * @return
-     * @since Servlet 3.0
-     * TODO SERVLET3 - Add comments
+     * @since Servlet 3.0 TODO SERVLET3 - Add comments
      */
     public boolean isAsyncSupported();
-    
+
     /**
-     * 
      * @return
      * @throws java.lang.IllegalStateException
-     * @since Servlet 3.0
-     * TODO SERVLET3 - Add comments
+     * @since Servlet 3.0 TODO SERVLET3 - Add comments
      */
     public AsyncContext getAsyncContext();
 
     /**
-     * 
      * @return
-     * @since Servlet 3.0
-     * TODO SERVLET3 - Add comments
+     * @since Servlet 3.0 TODO SERVLET3 - Add comments
      */
     public DispatcherType getDispatcherType();
 }
-

Modified: tomcat/trunk/java/javax/servlet/ServletRequestAttributeEvent.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/ServletRequestAttributeEvent.java?rev=967140&r1=967139&r2=967140&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/ServletRequestAttributeEvent.java (original)
+++ tomcat/trunk/java/javax/servlet/ServletRequestAttributeEvent.java Fri Jul 23 15:48:53 2010
@@ -1,67 +1,71 @@
 /*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements.  See the NOTICE file distributed with
-* this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
-* the License.  You may obtain a copy of the License at
-*
-*     http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package javax.servlet;
 
-
-    /** 
-      * This is the event class for notifications of changes to the 
-      * attributes of the servlet request in an application.
-      * @see ServletRequestAttributeListener
-      * @since	Servlet 2.4
-      */
-
-public class ServletRequestAttributeEvent extends ServletRequestEvent { 
+/**
+ * This is the event class for notifications of changes to the attributes of the
+ * servlet request in an application.
+ * 
+ * @see ServletRequestAttributeListener
+ * @since Servlet 2.4
+ */
+public class ServletRequestAttributeEvent extends ServletRequestEvent {
     private String name;
     private Object value;
 
-     /** Construct a ServletRequestAttributeEvent giving the servlet context
-      * of this web application, the ServletRequest whose attributes are
-      * changing and the name and value of the attribute.
-      *
-      * @param sc		the ServletContext that is sending the event.
-      * @param request		the ServletRequest that is sending the event.
-      * @param name		the name of the request attribute.
-      * @param value		the value of the request attribute.
-      */
-    public ServletRequestAttributeEvent(ServletContext sc, ServletRequest request, String name, Object value) {
+    /**
+     * Construct a ServletRequestAttributeEvent giving the servlet context of
+     * this web application, the ServletRequest whose attributes are changing
+     * and the name and value of the attribute.
+     * 
+     * @param sc
+     *            the ServletContext that is sending the event.
+     * @param request
+     *            the ServletRequest that is sending the event.
+     * @param name
+     *            the name of the request attribute.
+     * @param value
+     *            the value of the request attribute.
+     */
+    public ServletRequestAttributeEvent(ServletContext sc,
+            ServletRequest request, String name, Object value) {
         super(sc, request);
         this.name = name;
         this.value = value;
     }
 
     /**
-      * Return the name of the attribute that changed on the ServletRequest.
-      *
-      * @return		the name of the changed request attribute
-      */
+     * Return the name of the attribute that changed on the ServletRequest.
+     * 
+     * @return the name of the changed request attribute
+     */
     public String getName() {
         return this.name;
     }
 
     /**
-      * Returns the value of the attribute that has been added, removed or 
-      * replaced. If the attribute was added, this is the value of the 
-      * attribute. If the attribute was removed, this is the value of the 
-      * removed attribute. If the attribute was replaced, this is the old 
-      * value of the attribute.
-      *
-      * @return		the value of the changed request attribute
-      */
+     * Returns the value of the attribute that has been added, removed or
+     * replaced. If the attribute was added, this is the value of the attribute.
+     * If the attribute was removed, this is the value of the removed attribute.
+     * If the attribute was replaced, this is the old value of the attribute.
+     * 
+     * @return the value of the changed request attribute
+     */
     public Object getValue() {
-        return this.value;   
+        return this.value;
     }
 }

Modified: tomcat/trunk/java/javax/servlet/ServletRequestEvent.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/ServletRequestEvent.java?rev=967140&r1=967139&r2=967140&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/ServletRequestEvent.java (original)
+++ tomcat/trunk/java/javax/servlet/ServletRequestEvent.java Fri Jul 23 15:48:53 2010
@@ -1,56 +1,56 @@
 /*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements.  See the NOTICE file distributed with
-* this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
-* the License.  You may obtain a copy of the License at
-*
-*     http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package javax.servlet;
 
-
-    /** 
-      * Events of this kind indicate lifecycle
-      * events for a ServletRequest.
-      * The source of the event
-      * is the ServletContext of this web application.
-      * @see ServletRequestListener
-      * @since	Servlet 2.4
-      */
-
-public class ServletRequestEvent extends java.util.EventObject { 
+/**
+ * Events of this kind indicate lifecycle events for a ServletRequest. The
+ * source of the event is the ServletContext of this web application.
+ * 
+ * @see ServletRequestListener
+ * @since Servlet 2.4
+ */
+public class ServletRequestEvent extends java.util.EventObject {
     private ServletRequest request;
 
-    /** Construct a ServletRequestEvent for the given ServletContext
-      * and ServletRequest.
-      *
-      * @param sc		the ServletContext of the web application.
-      * @param request		the ServletRequest that is sending the event.
-      */
+    /**
+     * Construct a ServletRequestEvent for the given ServletContext and
+     * ServletRequest.
+     * 
+     * @param sc
+     *            the ServletContext of the web application.
+     * @param request
+     *            the ServletRequest that is sending the event.
+     */
     public ServletRequestEvent(ServletContext sc, ServletRequest request) {
         super(sc);
         this.request = request;
     }
-    
+
     /**
-      * Returns the ServletRequest that is changing.
-      */
-    public ServletRequest getServletRequest () { 
+     * Returns the ServletRequest that is changing.
+     */
+    public ServletRequest getServletRequest() {
         return this.request;
     }
 
     /**
-      * Returns the ServletContext of this web application.
-      */
-    public ServletContext getServletContext () { 
+     * Returns the ServletContext of this web application.
+     */
+    public ServletContext getServletContext() {
         return (ServletContext) super.getSource();
     }
 }

Modified: tomcat/trunk/java/javax/servlet/ServletRequestWrapper.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/ServletRequestWrapper.java?rev=967140&r1=967139&r2=967140&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/ServletRequestWrapper.java (original)
+++ tomcat/trunk/java/javax/servlet/ServletRequestWrapper.java Fri Jul 23 15:48:53 2010
@@ -1,19 +1,19 @@
 /*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements.  See the NOTICE file distributed with
-* this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
-* the License.  You may obtain a copy of the License at
-*
-*     http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package javax.servlet;
 
 import java.io.BufferedReader;
@@ -22,385 +22,299 @@ import java.util.Enumeration;
 import java.util.Locale;
 import java.util.Map;
 
-
-
 /**
+ * Provides a convenient implementation of the ServletRequest interface that can
+ * be subclassed by developers wishing to adapt the request to a Servlet. This
+ * class implements the Wrapper or Decorator pattern. Methods default to calling
+ * through to the wrapped request object.
  * 
- * Provides a convenient implementation of the ServletRequest interface that
- * can be subclassed by developers wishing to adapt the request to a Servlet.
- * This class implements the Wrapper or Decorator pattern. Methods default to
- * calling through to the wrapped request object.
-  * @since	v 2.3
- * 
- * 
- *
- * @see 	javax.servlet.ServletRequest
- *
+ * @since v 2.3
+ * @see javax.servlet.ServletRequest
  */
-
 public class ServletRequestWrapper implements ServletRequest {
     private ServletRequest request;
 
-	/**
-	* Creates a ServletRequest adaptor wrapping the given request object. 
-	* @throws java.lang.IllegalArgumentException if the request is null
-	*/
-
+    /**
+     * Creates a ServletRequest adaptor wrapping the given request object.
+     * 
+     * @throws java.lang.IllegalArgumentException
+     *             if the request is null
+     */
     public ServletRequestWrapper(ServletRequest request) {
-	if (request == null) {
-	    throw new IllegalArgumentException("Request cannot be null");   
-	}
-	this.request = request;
-    }
-
-	/**
-	* Return the wrapped request object.
-	*/
-	public ServletRequest getRequest() {
-		return this.request;
-	}
-	
-	/**
-	* Sets the request object being wrapped. 
-	* @throws java.lang.IllegalArgumentException if the request is null.
-	*/
-	
-	public void setRequest(ServletRequest request) {
-	    if (request == null) {
-		throw new IllegalArgumentException("Request cannot be null");
-	    }
-	    this.request = request;
-	}
+        if (request == null) {
+            throw new IllegalArgumentException("Request cannot be null");
+        }
+        this.request = request;
+    }
 
     /**
-     *
-     * The default behavior of this method is to call getAttribute(String name)
-     * on the wrapped request object.
+     * Return the wrapped request object.
      */
+    public ServletRequest getRequest() {
+        return this.request;
+    }
 
-    public Object getAttribute(String name) {
-	return this.request.getAttribute(name);
-	}
-    
-    
+    /**
+     * Sets the request object being wrapped.
+     * 
+     * @throws java.lang.IllegalArgumentException
+     *             if the request is null.
+     */
+    public void setRequest(ServletRequest request) {
+        if (request == null) {
+            throw new IllegalArgumentException("Request cannot be null");
+        }
+        this.request = request;
+    }
 
     /**
-     * The default behavior of this method is to return getAttributeNames()
+     * The default behavior of this method is to call getAttribute(String name)
      * on the wrapped request object.
      */
+    public Object getAttribute(String name) {
+        return this.request.getAttribute(name);
+    }
 
-    public Enumeration<String> getAttributeNames() {
-	return this.request.getAttributeNames();
-	}    
-    
-    
-    
     /**
-      * The default behavior of this method is to return getCharacterEncoding()
-     * on the wrapped request object.
+     * The default behavior of this method is to return getAttributeNames() on
+     * the wrapped request object.
      */
+    public Enumeration<String> getAttributeNames() {
+        return this.request.getAttributeNames();
+    }
 
-    public String getCharacterEncoding() {
-	return this.request.getCharacterEncoding();
-	}
-	
     /**
-      * The default behavior of this method is to set the character encoding
+     * The default behavior of this method is to return getCharacterEncoding()
      * on the wrapped request object.
      */
+    public String getCharacterEncoding() {
+        return this.request.getCharacterEncoding();
+    }
 
-    public void setCharacterEncoding(String enc) throws java.io.UnsupportedEncodingException {
-	this.request.setCharacterEncoding(enc);
-	}
-    
-    
     /**
-      * The default behavior of this method is to return getContentLength()
-     * on the wrapped request object.
+     * The default behavior of this method is to set the character encoding on
+     * the wrapped request object.
      */
+    public void setCharacterEncoding(String enc)
+            throws java.io.UnsupportedEncodingException {
+        this.request.setCharacterEncoding(enc);
+    }
 
+    /**
+     * The default behavior of this method is to return getContentLength() on
+     * the wrapped request object.
+     */
     public int getContentLength() {
-	return this.request.getContentLength();
+        return this.request.getContentLength();
     }
-    
-    
-    
 
-       /**
-      * The default behavior of this method is to return getContentType()
-     * on the wrapped request object.
+    /**
+     * The default behavior of this method is to return getContentType() on the
+     * wrapped request object.
      */
     public String getContentType() {
-	return this.request.getContentType();
+        return this.request.getContentType();
     }
-    
-    
-    
 
-     /**
-      * The default behavior of this method is to return getInputStream()
-     * on the wrapped request object.
+    /**
+     * The default behavior of this method is to return getInputStream() on the
+     * wrapped request object.
      */
-
     public ServletInputStream getInputStream() throws IOException {
-	return this.request.getInputStream();
-	}
-     
-    
-    
+        return this.request.getInputStream();
+    }
 
     /**
-      * The default behavior of this method is to return getParameter(String name)
-     * on the wrapped request object.
+     * The default behavior of this method is to return getParameter(String
+     * name) on the wrapped request object.
      */
-
     public String getParameter(String name) {
-	return this.request.getParameter(name);
+        return this.request.getParameter(name);
     }
-    
+
     /**
-      * The default behavior of this method is to return getParameterMap()
-     * on the wrapped request object.
+     * The default behavior of this method is to return getParameterMap() on the
+     * wrapped request object.
      */
-    public Map<String,String[]> getParameterMap() {
-	return this.request.getParameterMap();
+    public Map<String, String[]> getParameterMap() {
+        return this.request.getParameterMap();
     }
-    
-    
-    
 
     /**
-      * The default behavior of this method is to return getParameterNames()
-     * on the wrapped request object.
+     * The default behavior of this method is to return getParameterNames() on
+     * the wrapped request object.
      */
-     
     public Enumeration<String> getParameterNames() {
-	return this.request.getParameterNames();
+        return this.request.getParameterNames();
     }
-    
-    
-    
 
-       /**
-      * The default behavior of this method is to return getParameterValues(String name)
-     * on the wrapped request object.
+    /**
+     * The default behavior of this method is to return
+     * getParameterValues(String name) on the wrapped request object.
      */
     public String[] getParameterValues(String name) {
-	return this.request.getParameterValues(name);
-	}
-    
-    
-    
+        return this.request.getParameterValues(name);
+    }
 
-     /**
-      * The default behavior of this method is to return getProtocol()
-     * on the wrapped request object.
+    /**
+     * The default behavior of this method is to return getProtocol() on the
+     * wrapped request object.
      */
-    
     public String getProtocol() {
-	return this.request.getProtocol();
-	}
-    
-    
-    
+        return this.request.getProtocol();
+    }
 
     /**
-      * The default behavior of this method is to return getScheme()
-     * on the wrapped request object.
+     * The default behavior of this method is to return getScheme() on the
+     * wrapped request object.
      */
-    
-
     public String getScheme() {
-	return this.request.getScheme();
-	}
-    
-    
-    
+        return this.request.getScheme();
+    }
 
     /**
-      * The default behavior of this method is to return getServerName()
-     * on the wrapped request object.
+     * The default behavior of this method is to return getServerName() on the
+     * wrapped request object.
      */
     public String getServerName() {
-	return this.request.getServerName();
-	}
-    
-    
-    
+        return this.request.getServerName();
+    }
 
-   /**
-      * The default behavior of this method is to return getServerPort()
-     * on the wrapped request object.
+    /**
+     * The default behavior of this method is to return getServerPort() on the
+     * wrapped request object.
      */
-
     public int getServerPort() {
-	return this.request.getServerPort();
-	}
-    
-    
-    
-  /**
-      * The default behavior of this method is to return getReader()
-     * on the wrapped request object.
-     */
+        return this.request.getServerPort();
+    }
 
+    /**
+     * The default behavior of this method is to return getReader() on the
+     * wrapped request object.
+     */
     public BufferedReader getReader() throws IOException {
-	return this.request.getReader();
-	}
-    
-    
-    
+        return this.request.getReader();
+    }
 
     /**
-      * The default behavior of this method is to return getRemoteAddr()
-     * on the wrapped request object.
+     * The default behavior of this method is to return getRemoteAddr() on the
+     * wrapped request object.
      */
-    
     public String getRemoteAddr() {
-	return this.request.getRemoteAddr();
+        return this.request.getRemoteAddr();
     }
-    
-    
-    
 
-      /**
-      * The default behavior of this method is to return getRemoteHost()
-     * on the wrapped request object.
+    /**
+     * The default behavior of this method is to return getRemoteHost() on the
+     * wrapped request object.
      */
-
     public String getRemoteHost() {
-	return this.request.getRemoteHost();
+        return this.request.getRemoteHost();
     }
-    
-    
-    
 
     /**
-      * The default behavior of this method is to return setAttribute(String name, Object o)
-     * on the wrapped request object.
+     * The default behavior of this method is to return setAttribute(String
+     * name, Object o) on the wrapped request object.
      */
-
     public void setAttribute(String name, Object o) {
-	this.request.setAttribute(name, o);
+        this.request.setAttribute(name, o);
     }
-    
-    
-    
 
     /**
-      * The default behavior of this method is to call removeAttribute(String name)
-     * on the wrapped request object.
+     * The default behavior of this method is to call removeAttribute(String
+     * name) on the wrapped request object.
      */
     public void removeAttribute(String name) {
-	this.request.removeAttribute(name);
+        this.request.removeAttribute(name);
     }
-    
-    
-    
 
-   /**
-      * The default behavior of this method is to return getLocale()
-     * on the wrapped request object.
+    /**
+     * The default behavior of this method is to return getLocale() on the
+     * wrapped request object.
      */
-
     public Locale getLocale() {
-	return this.request.getLocale();
+        return this.request.getLocale();
     }
-    
-    
-    
 
-     /**
-      * The default behavior of this method is to return getLocales()
-     * on the wrapped request object.
+    /**
+     * The default behavior of this method is to return getLocales() on the
+     * wrapped request object.
      */
-
     public Enumeration<Locale> getLocales() {
-	return this.request.getLocales();
+        return this.request.getLocales();
     }
-    
-    
-    
 
     /**
-      * The default behavior of this method is to return isSecure()
-     * on the wrapped request object.
+     * The default behavior of this method is to return isSecure() on the
+     * wrapped request object.
      */
-
     public boolean isSecure() {
-	return this.request.isSecure();
+        return this.request.isSecure();
     }
-    
-    
-    
 
     /**
-      * The default behavior of this method is to return getRequestDispatcher(String path)
-     * on the wrapped request object.
+     * The default behavior of this method is to return
+     * getRequestDispatcher(String path) on the wrapped request object.
      */
-
     public RequestDispatcher getRequestDispatcher(String path) {
-	return this.request.getRequestDispatcher(path);
+        return this.request.getRequestDispatcher(path);
     }
-    
-    
-    
 
     /**
-      * The default behavior of this method is to return getRealPath(String path)
+     * The default behavior of this method is to return getRealPath(String path)
      * on the wrapped request object.
+     * 
      * @deprecated As of Version 3.0 of the Java Servlet API
      */
-    @SuppressWarnings("dep-ann") // Spec API does not use @Deprecated
+    @SuppressWarnings("dep-ann")
+    // Spec API does not use @Deprecated
     public String getRealPath(String path) {
-	return this.request.getRealPath(path);
+        return this.request.getRealPath(path);
     }
-    
+
     /**
-     * The default behavior of this method is to return
-     * getRemotePort() on the wrapped request object.
-     *
+     * The default behavior of this method is to return getRemotePort() on the
+     * wrapped request object.
+     * 
      * @since 2.4
-     */    
-    public int getRemotePort(){
+     */
+    public int getRemotePort() {
         return this.request.getRemotePort();
     }
 
-
     /**
-     * The default behavior of this method is to return
-     * getLocalName() on the wrapped request object.
-     *
+     * The default behavior of this method is to return getLocalName() on the
+     * wrapped request object.
+     * 
      * @since 2.4
      */
-    public String getLocalName(){
+    public String getLocalName() {
         return this.request.getLocalName();
     }
 
     /**
-     * The default behavior of this method is to return
-     * getLocalAddr() on the wrapped request object.
-     *
+     * The default behavior of this method is to return getLocalAddr() on the
+     * wrapped request object.
+     * 
      * @since 2.4
-     */       
-    public String getLocalAddr(){
+     */
+    public String getLocalAddr() {
         return this.request.getLocalAddr();
     }
 
-
     /**
-     * The default behavior of this method is to return
-     * getLocalPort() on the wrapped request object.
-     *
+     * The default behavior of this method is to return getLocalPort() on the
+     * wrapped request object.
+     * 
      * @since 2.4
      */
-    public int getLocalPort(){
+    public int getLocalPort() {
         return this.request.getLocalPort();
     }
 
     /**
-     * The default behavior of this method is to return
-     * getServletContext() on the wrapped request object.
+     * The default behavior of this method is to return getServletContext() on
+     * the wrapped request object.
      * 
      * @return
      * @since Servlet 3.0
@@ -408,10 +322,10 @@ public class ServletRequestWrapper imple
     public ServletContext getServletContext() {
         return request.getServletContext();
     }
-    
+
     /**
-     * The default behavior of this method is to return
-     * startAsync() on the wrapped request object.
+     * The default behavior of this method is to return startAsync() on the
+     * wrapped request object.
      * 
      * @return
      * @throws java.lang.IllegalStateException
@@ -420,10 +334,10 @@ public class ServletRequestWrapper imple
     public AsyncContext startAsync() {
         return request.startAsync();
     }
-    
+
     /**
-     * The default behavior of this method is to return
-     * startAsync(Runnable) on the wrapped request object.
+     * The default behavior of this method is to return startAsync(Runnable) on
+     * the wrapped request object.
      * 
      * @param servletRequest
      * @param servletResponse
@@ -432,14 +346,13 @@ public class ServletRequestWrapper imple
      * @since Servlet 3.0
      */
     public AsyncContext startAsync(ServletRequest servletRequest,
-            ServletResponse servletResponse)
-            throws IllegalStateException {
+            ServletResponse servletResponse) throws IllegalStateException {
         return request.startAsync(servletRequest, servletResponse);
     }
-    
+
     /**
-     * The default behavior of this method is to return
-     * isAsyncStarted() on the wrapped request object.
+     * The default behavior of this method is to return isAsyncStarted() on the
+     * wrapped request object.
      * 
      * @return
      * @since Servlet 3.0
@@ -449,8 +362,8 @@ public class ServletRequestWrapper imple
     }
 
     /**
-     * The default behavior of this method is to return
-     * isAsyncSupported() on the wrapped request object.
+     * The default behavior of this method is to return isAsyncSupported() on
+     * the wrapped request object.
      * 
      * @return
      * @since Servlet 3.0
@@ -458,10 +371,10 @@ public class ServletRequestWrapper imple
     public boolean isAsyncSupported() {
         return request.isAsyncSupported();
     }
-    
+
     /**
-     * The default behavior of this method is to return
-     * getAsyncContext() on the wrapped request object.
+     * The default behavior of this method is to return getAsyncContext() on the
+     * wrapped request object.
      * 
      * @return
      * @since Servlet 3.0
@@ -471,41 +384,38 @@ public class ServletRequestWrapper imple
     }
 
     /**
-     * 
      * @param wrapped
-     * @since Servlet 3.0
-     * TODO SERVLET3 - Add comments
+     * @since Servlet 3.0 TODO SERVLET3 - Add comments
      */
     public boolean isWrapperFor(ServletRequest wrapped) {
         if (request == wrapped) {
             return true;
         }
         if (request instanceof ServletRequestWrapper) {
-            return ((ServletRequestWrapper)request).isWrapperFor(wrapped);
+            return ((ServletRequestWrapper) request).isWrapperFor(wrapped);
         }
         return false;
     }
-    
+
     /**
-     * 
      * @param wrappedType
-     * @since Servlet 3.0
-     * TODO SERVLET3 - Add comments
+     * @since Servlet 3.0 TODO SERVLET3 - Add comments
      */
-    @SuppressWarnings("unchecked") // Spec API does not use generics
+    @SuppressWarnings("unchecked")
+    // Spec API does not use generics
     public boolean isWrapperFor(Class wrappedType) {
         if (wrappedType.isAssignableFrom(request.getClass())) {
             return true;
         }
         if (request instanceof ServletRequestWrapper) {
-            return ((ServletRequestWrapper)request).isWrapperFor(wrappedType);
+            return ((ServletRequestWrapper) request).isWrapperFor(wrappedType);
         }
         return false;
     }
-    
+
     /**
-     * The default behavior of this method is to call
-     * getDispatcherType() on the wrapped request object.
+     * The default behavior of this method is to call getDispatcherType() on the
+     * wrapped request object.
      * 
      * @since Servlet 3.0
      */
@@ -513,4 +423,3 @@ public class ServletRequestWrapper imple
         return this.request.getDispatcherType();
     }
 }
-



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


Mime
View raw message