Author: markt
Date: Sat Oct 13 20:46:26 2012
New Revision: 1397945
URL: http://svn.apache.org/viewvc?rev=1397945&view=rev
Log:
Fill in some Servlet 3.0 Javadoc
Modified:
tomcat/tc7.0.x/trunk/ (props changed)
tomcat/tc7.0.x/trunk/java/javax/servlet/http/HttpServletResponse.java
tomcat/tc7.0.x/trunk/java/javax/servlet/http/HttpServletResponseWrapper.java
tomcat/tc7.0.x/trunk/java/javax/servlet/http/HttpSession.java
tomcat/tc7.0.x/trunk/java/org/apache/catalina/connector/Response.java
Propchange: tomcat/tc7.0.x/trunk/
------------------------------------------------------------------------------
Merged /tomcat/trunk:r1397944
Modified: tomcat/tc7.0.x/trunk/java/javax/servlet/http/HttpServletResponse.java
URL:
http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/java/javax/servlet/http/HttpServletResponse.java?rev=1397945&r1=1397944&r2=1397945&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/java/javax/servlet/http/HttpServletResponse.java
(original)
+++ tomcat/tc7.0.x/trunk/java/javax/servlet/http/HttpServletResponse.java Sat
Oct 13 20:46:26 2012
@@ -29,8 +29,6 @@ import javax.servlet.ServletResponse;
* The servlet container creates an <code>HttpServletResponse</code> object and
* passes it as an argument to the servlet's service methods
(<code>doGet</code>, <code>doPost</code>, etc).
*
- * @author Various
- * @version $Version$
* @see javax.servlet.ServletResponse
*/
public interface HttpServletResponse extends ServletResponse {
@@ -301,28 +299,38 @@ public interface HttpServletResponse ext
public void setStatus(int sc, String sm);
/**
- * @return TODO
- * @since Servlet 3.0 TODO SERVLET3 - Add comments
+ * Return the HTTP status code associated with this Response.
+ *
+ * @since Servlet 3.0
*/
public int getStatus();
/**
- * @param name
- * @return TODO
- * @since Servlet 3.0 TODO SERVLET3 - Add comments
+ * Return the value for the specified header, or <code>null</code> if this
+ * header has not been set. If more than one value was added for this
+ * name, only the first is returned; use {@link #getHeaders(String)} to
+ * retrieve all of them.
+ *
+ * @param name Header name to look up
+ *
+ * @since Servlet 3.0
*/
public String getHeader(String name);
/**
- * @param name
- * @return TODO
- * @since Servlet 3.0 TODO SERVLET3 - Add comments
+ * Return a Collection of all the header values associated with the
+ * specified header name.
+ *
+ * @param name Header name to look up
+ *
+ * @since Servlet 3.0
*/
public Collection<String> getHeaders(String name);
/**
- * @return TODO
- * @since Servlet 3.0 TODO SERVLET3 - Add comments
+ * Return an Iterable of all the header names set for this response.
+ *
+ * @since Servlet 3.0
*/
public Collection<String> getHeaderNames();
Modified:
tomcat/tc7.0.x/trunk/java/javax/servlet/http/HttpServletResponseWrapper.java
URL:
http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/java/javax/servlet/http/HttpServletResponseWrapper.java?rev=1397945&r1=1397944&r2=1397945&view=diff
==============================================================================
---
tomcat/tc7.0.x/trunk/java/javax/servlet/http/HttpServletResponseWrapper.java
(original)
+++
tomcat/tc7.0.x/trunk/java/javax/servlet/http/HttpServletResponseWrapper.java
Sat Oct 13 20:46:26 2012
@@ -215,7 +215,13 @@ public class HttpServletResponseWrapper
}
/**
- * @since Servlet 3.0 TODO SERVLET3 - Add comments
+ * {@inheritDoc}
+ * <p>
+ * The default implementation is to call
+ * {@link HttpServletResponse#getStatus()}
+ * on the wrapper {@link HttpServletResponse}.
+ *
+ * @since Servlet 3.0
*/
@Override
public int getStatus() {
@@ -223,7 +229,13 @@ public class HttpServletResponseWrapper
}
/**
- * @since Servlet 3.0 TODO SERVLET3 - Add comments
+ * {@inheritDoc}
+ * <p>
+ * The default implementation is to call
+ * {@link HttpServletResponse#getHeader(String)}
+ * on the wrapper {@link HttpServletResponse}.
+ *
+ * @since Servlet 3.0
*/
@Override
public String getHeader(String name) {
@@ -231,7 +243,13 @@ public class HttpServletResponseWrapper
}
/**
- * @since Servlet 3.0 TODO SERVLET3 - Add comments
+ * {@inheritDoc}
+ * <p>
+ * The default implementation is to call
+ * {@link HttpServletResponse#getHeaders(String)}
+ * on the wrapper {@link HttpServletResponse}.
+ *
+ * @since Servlet 3.0
*/
@Override
public Collection<String> getHeaders(String name) {
@@ -239,7 +257,13 @@ public class HttpServletResponseWrapper
}
/**
- * @since Servlet 3.0 TODO SERVLET3 - Add comments
+ * {@inheritDoc}
+ * <p>
+ * The default implementation is to call
+ * {@link HttpServletResponse#getHeaderNames()}
+ * on the wrapper {@link HttpServletResponse}.
+ *
+ * @since Servlet 3.0
*/
@Override
public Collection<String> getHeaderNames() {
Modified: tomcat/tc7.0.x/trunk/java/javax/servlet/http/HttpSession.java
URL:
http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/java/javax/servlet/http/HttpSession.java?rev=1397945&r1=1397944&r2=1397945&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/java/javax/servlet/http/HttpSession.java (original)
+++ tomcat/tc7.0.x/trunk/java/javax/servlet/http/HttpSession.java Sat Oct 13
20:46:26 2012
@@ -61,10 +61,7 @@ import javax.servlet.ServletContext;
* <code>ServletContext</code>), so information stored in one context will not
* be directly visible in another.
*
- * @author Various
- * @version $Version$
* @see HttpSessionBindingListener
- * @see HttpSessionContext
*/
public interface HttpSession {
Modified: tomcat/tc7.0.x/trunk/java/org/apache/catalina/connector/Response.java
URL:
http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/java/org/apache/catalina/connector/Response.java?rev=1397945&r1=1397944&r2=1397945&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/java/org/apache/catalina/connector/Response.java
(original)
+++ tomcat/tc7.0.x/trunk/java/org/apache/catalina/connector/Response.java Sat
Oct 13 20:46:26 2012
@@ -896,23 +896,12 @@ public class Response
// --------------------------------------------------- HttpResponse Methods
- /**
- * Return the value for the specified header, or <code>null</code> if this
- * header has not been set. If more than one value was added for this
- * name, only the first is returned; use {@link #getHeaders(String)} to
- * retrieve all of them.
- *
- * @param name Header name to look up
- */
@Override
public String getHeader(String name) {
return coyoteResponse.getMimeHeaders().getHeader(name);
}
- /**
- * Return an Iterable of all the header names set for this response.
- */
@Override
public Collection<String> getHeaderNames() {
@@ -927,12 +916,6 @@ public class Response
}
- /**
- * Return a Collection of all the header values associated with the
- * specified header name.
- *
- * @param name Header name to look up
- */
@Override
public Collection<String> getHeaders(String name) {
@@ -955,9 +938,6 @@ public class Response
}
- /**
- * Return the HTTP status code associated with this Response.
- */
@Override
public int getStatus() {
return coyoteResponse.getStatus();
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
