Fixed javadoc errors
diff --git a/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/HttpDate.java b/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/HttpDate.java
index 17fc8d0..7d0184e 100644
--- a/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/HttpDate.java
+++ b/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/HttpDate.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 1999, 2006 IBM Corporation and others.
+ * Copyright (c) 1999, 2009 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -37,7 +37,7 @@
/**
* Constructs an HTTPDate object from the passed long.
- * @param itime the number of uSeconds since the epoch.
+ * @param iTime the number of uSeconds since the epoch.
*/
public HttpDate(long iTime) { // Raw mill seconds
this();
@@ -65,7 +65,7 @@
/**
* Constructs an HTTPDate object from the passed long.
- * @param itime the number of uSeconds since the epoch.
+ * @param iTime the number of uSeconds since the epoch.
*/
public HttpDate(Date iTime) { // Raw mill seconds
this();
@@ -163,7 +163,7 @@
}
/**
- * Checks wether or not the Date this object represents is valid.
+ * Checks whether or not the Date this object represents is valid.
* It would be Invalid if the string used to construct the object was a NON
* RFC 1123, 1036 or ASC Time conforming Date String.
* @return true if this object represents a REAL date.
@@ -241,7 +241,7 @@
return;
} catch (NumberFormatException e) {
valid = false;
- }
+ }
}
protected void parseRFC1036(String str) {
@@ -357,7 +357,6 @@
valid = false;
}
-
}
/**
diff --git a/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/ResourceRegistration.java b/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/ResourceRegistration.java
index 36e22e5..9aafa7e 100644
--- a/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/ResourceRegistration.java
+++ b/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/ResourceRegistration.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 1999, 2006 IBM Corporation and others.
+ * Copyright (c) 1999, 2009 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -16,7 +16,6 @@
import javax.servlet.ServletException;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.*;
-
import org.eclipse.equinox.http.servlet.HttpServletRequestImpl;
import org.eclipse.equinox.http.servlet.HttpServletResponseImpl;
import org.osgi.framework.Bundle;
@@ -60,7 +59,7 @@
* This method returns the correct MIME type of a given URI by first checking
* the HttpContext::getMimeType and, if null, checking the httpservice's MIMETypes table.
* @return java.lang.String
- * @param URI java.lang.String
+ * @param name java.lang.String
*/
private String computeMimeType(String name, URLConnection conn) {
String mimeType = httpContext.getMimeType(name);
diff --git a/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/StaticDataReader.java b/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/StaticDataReader.java
index be77cf6..fec2ebf 100644
--- a/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/StaticDataReader.java
+++ b/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/StaticDataReader.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 1999, 2006 IBM Corporation and others.
+ * Copyright (c) 1999, 2009 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -47,7 +47,7 @@
* files which are directories, such as
* http://www.ibm.com/ are assumed to be HTML, rather than appOctet.
*
- * @param String filename - the name of the file, which must
+ * @param filename - the name of the file, which must
* not be null.
* @returns String - the mime type of the file.
*/
diff --git a/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/HttpServletRequestImpl.java b/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/HttpServletRequestImpl.java
index eb0221b..d1520e0 100644
--- a/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/HttpServletRequestImpl.java
+++ b/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/HttpServletRequestImpl.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 1999, 2006 IBM Corporation and others.
+ * Copyright (c) 1999, 2009 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -16,7 +16,6 @@
import javax.servlet.RequestDispatcher;
import javax.servlet.ServletInputStream;
import javax.servlet.http.*;
-
import org.eclipse.equinox.http.*;
import org.eclipse.equinox.socket.SocketInterface;
import org.eclipse.osgi.util.NLS;
@@ -382,10 +381,9 @@
/**
* Returns an input stream for reading binary data in the request body.
*
- * @see getReader
+ * @see #getReader()
* @exception IllegalStateException if getReader has been
* called on this same request.
- * @exception IOException on other I/O related errors.
*/
public ServletInputStream getInputStream() {
if (inputstream == null) {
@@ -564,13 +562,10 @@
* Returns a buffered reader for reading text in the request body.
* This translates character set encodings as appropriate.
*
- * @see getInputStream
+ * @see #getInputStream()
*
- * @exception UnsupportedEncodingException if the character set encoding
- * is unsupported, so the text can't be correctly decoded.
* @exception IllegalStateException if getInputStream has been
* called on this same request.
- * @exception IOException on other I/O related errors.
*/
public BufferedReader getReader() {
if (reader == null) {
@@ -1309,7 +1304,7 @@
* nested servlets.
*
* @param name Attribute name
- * @param object Attribute value
+ * @param val Attribute value
*/
public void setAttribute(String name, Object val) {
if (attributes == null) {
diff --git a/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/HttpServletResponseImpl.java b/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/HttpServletResponseImpl.java
index 463c735..d7518be 100644
--- a/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/HttpServletResponseImpl.java
+++ b/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/HttpServletResponseImpl.java
@@ -342,10 +342,9 @@
/**
* Returns an output stream for writing binary response data.
*
- * @see getWriter
+ * @see #getWriter()
* @exception IllegalStateException if getWriter has been
* called on this same request.
- * @exception IOException if an I/O exception has occurred
*/
public ServletOutputStream getOutputStream() {
if (!gotOutputStream) {
@@ -367,8 +366,8 @@
* property. This means that the content type must be set before
* calling this method.
*
- * @see getOutputStream
- * @see setContentType
+ * @see #getOutputStream()
+ * @see #setContentType(String)
*
* @exception UnsupportedEncodingException if no such charset can
* be provided
@@ -416,7 +415,7 @@
/**
* Sends an error response to the client using the specified
* status code and a default message.
- * @param sc the status code
+ * @param statusCode the status code
* @exception IOException If an I/O error has occurred.
*/
public void sendError(int statusCode) throws IOException {
@@ -484,7 +483,7 @@
*/
public void setContentLength(int len) {
- // BUGBUG response should be considered commited and closed
+ // BUGBUG response should be considered committed and closed
// when content length has been written.
// Not sure if content length is bytes or chars?
contentLength = len;
@@ -505,8 +504,9 @@
* data.
*
* @param type the content's MIME type
- * @see getOutputStream
- * @see getWriter */
+ * @see #getOutputStream()
+ * @see #getWriter()
+ */
public void setContentType(String type) {
if (contentType == null) {
synchronized (this) {
@@ -617,7 +617,7 @@
* presence of a header before setting its value.
*
* @param name the name of the header field
- * @param value the header field's date value
+ * @param date the header field's date value
*
* @see #containsHeader
*/
@@ -675,7 +675,7 @@
* is an error, the <code>sendError</code> method should be used
* instead.
*
- * @param sc the status code
+ * @param statusCode the status code
*
* @see #sendError
*/
@@ -692,8 +692,8 @@
* The page is sent with a default HTML header; the message
* is enclosed in simple body tags (<body></body>).
*
- * @param sc the status code
- * @param sm the status message
+ * @param si the status code
+ * @param ss the status message
* deprecated
*/
public void setStatus(int si, String ss) {
diff --git a/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/HttpSessionContextImpl.java b/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/HttpSessionContextImpl.java
index 10c519d..dfcaf3e 100644
--- a/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/HttpSessionContextImpl.java
+++ b/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/HttpSessionContextImpl.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 1999, 2006 IBM Corporation and others.
+ * Copyright (c) 1999, 2009 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -42,7 +42,7 @@
/**
* Returns the session bound to the specified session ID.
*
- * @param sessionID the ID of a particular session object
+ * @param sessionId the ID of a particular session object
* @return the session name. Returns null if the session ID does not refer
* to a valid session.
* @deprecated
diff --git a/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/RequestDispatcherImpl.java b/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/RequestDispatcherImpl.java
index 05d97f8..09fca65 100644
--- a/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/RequestDispatcherImpl.java
+++ b/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/RequestDispatcherImpl.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 1999, 2006 IBM Corporation and others.
+ * Copyright (c) 1999, 2009 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -213,20 +213,20 @@
*
* <p>The <tt>request</tt> object passed to the target object
* will have its request URL path and other path parameters
- * adjusted to reflect the target URL path of the target ojbect.
+ * adjusted to reflect the target URL path of the target object.
*
* <p>You cannot use this method if a <tt>ServletOutputStream</tt>
* object or <tt>PrintWriter</tt> object has been obtained from
* the response. In that case, the method throws an
* <tt>IllegalStateException</tt>
*
- * @param request the client's request on the servlet
- * @param response the client's response from the servlet
+ * @param req the client's request on the servlet
+ * @param res the client's response from the servlet
* @exception ServletException if a servlet exception is thrown by the
* target servlet
* @exception IOException if an I/O Exception occurs
* @exception IllegalStateException if the ServletOutputStream or a writer
- * had allready been obtained from the response object
+ * had already been obtained from the response object
*/
public void forward(ServletRequest req, ServletResponse res) throws ServletException, IOException {
// BUGBUG If the response has already been committed, then an
@@ -272,8 +272,8 @@
* To ensure that a session works correctly, start the session
* outside of the included servlet, even if you use session tracking.
*
- * @param request the client's request on the servlet
- * @param response the client's response from the servlet
+ * @param req the client's request on the servlet
+ * @param res the client's response from the servlet
* @exception ServletException if a servlet exception is thrown by the
* target servlet
* @exception IOException if the ServletOutputStream or a writer
diff --git a/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/ServletContextImpl.java b/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/ServletContextImpl.java
index 9392874..015e488 100644
--- a/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/ServletContextImpl.java
+++ b/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/ServletContextImpl.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 1999, 2006, 2008 IBM Corporation and others.
+ * Copyright (c) 1999, 2009 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -253,10 +253,10 @@
* <tt>getResourceAsStream</tt> method of <tt>java.lang.Class</tt>.
* The method in <tt>java.lang.Class</tt> looks up resources
* based on class loader. This method allows servlet engines
- * to make resources avaialble to a servlet from any source
+ * to make resources available to a servlet from any source
* without regards to class loaders, location, etc.
*
- * @param name
+ * @param path
*/
public InputStream getResourceAsStream(String path) {
@@ -362,7 +362,7 @@
* name and type of the servlet log is servlet engine specific,
* but is normally an event log.
*
- * @param msg the message to be written
+ * @param message the message to be written
* @param throwable the exception to be written
*/
@@ -385,7 +385,7 @@
/**
* Binds an object to a given name in this context. If an object
- * is allready bound into the context with the given name,
+ * is already bound into the context with the given name,
* it will be replaced.
*
* Attribute names should follow the same convention as package names.
@@ -393,7 +393,7 @@
* definition by this specification or by the reference implementation.
*
* @param name the name of the attribute to store
- * @param value the value of the attribute
+ * @param object the value of the attribute
*/
public void setAttribute(String name, Object object) {
diff --git a/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/ServletInputStreamImpl.java b/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/ServletInputStreamImpl.java
index 37c326f..08a3a9e 100644
--- a/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/ServletInputStreamImpl.java
+++ b/bundles/org.eclipse.equinox.http/src/org/eclipse/equinox/http/servlet/ServletInputStreamImpl.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 1999, 2005 IBM Corporation.
+ * Copyright (c) 1999, 2009 IBM Corporation.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -82,7 +82,6 @@
*
* @param len Content-Length of InputStream
* @return InputStream for use by servlets
- * @exception
*/
ServletInputStream getServletInputStream(int len) {
if (servletInputStream == null) {
@@ -106,13 +105,13 @@
* the last marked position so that subsequent reads re-read the same
* bytes.
* <p>
- * The <code>readlimit</code> arguments tells this input stream to
+ * The <code>readLimit</code> arguments tells this input stream to
* allow that many bytes to be read before the mark position gets
* invalidated.
* <p>
* The <code>mark</code> method of <code>InputStream</code> does nothing.
*
- * @param readlimit the maximum limit of bytes that can be read before
+ * @param readLimit the maximum limit of bytes that can be read before
* the mark position becomes invalid.
* @see java.io.InputStream#reset()
* @since JDK1.0
@@ -249,7 +248,7 @@
* been reached. Subclasses are encouraged to provide a more
* efficient implementation of this method.
*
- * @param n the number of bytes to be skipped.
+ * @param len the number of bytes to be skipped.
* @return the actual number of bytes skipped.
* @exception IOException if an I/O error occurs.
* @since JDK1.0
@@ -318,13 +317,13 @@
* the last marked position so that subsequent reads re-read the same
* bytes.
* <p>
- * The <code>readlimit</code> arguments tells this input stream to
+ * The <code>readLimit</code> arguments tells this input stream to
* allow that many bytes to be read before the mark position gets
* invalidated.
* <p>
* The <code>mark</code> method of <code>InputStream</code> does nothing.
*
- * @param readlimit the maximum limit of bytes that can be read before
+ * @param readLimit the maximum limit of bytes that can be read before
* the mark position becomes invalid.
* @see java.io.InputStream#reset()
* @since JDK1.0
@@ -491,7 +490,7 @@
* been reached. Subclasses are encouraged to provide a more
* efficient implementation of this method.
*
- * @param n the number of bytes to be skipped.
+ * @param len the number of bytes to be skipped.
* @return the actual number of bytes skipped.
* @exception IOException if an I/O error occurs.
* @since JDK1.0
