dion 02/04/10 19:34:54
Modified: latka/src/java/org/apache/commons/latka/http
RequestHeaders.java Request.java
RequestHeadersImpl.java
Log:
Javadoc cleanup
Revision Changes Path
1.3 +21 -12
jakarta-commons/latka/src/java/org/apache/commons/latka/http/RequestHeaders.java
Index: RequestHeaders.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/latka/src/java/org/apache/commons/latka/http/RequestHeaders.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- RequestHeaders.java 20 Jan 2002 00:03:41 -0000 1.2
+++ RequestHeaders.java 11 Apr 2002 02:34:53 -0000 1.3
@@ -1,9 +1,13 @@
/*
+ *
+ *
+ *
+ *
* ====================================================================
*
* The Apache Software License, Version 1.1
*
- * Copyright (c) 1999 The Apache Software Foundation. All rights
+ * Copyright (c) 1999-2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -11,7 +15,7 @@
* are met:
*
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
+ * notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
@@ -19,15 +23,15 @@
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
- * any, must include the following acknowlegement:
- * "This product includes software developed by the
+ * any, must include the following acknowlegement:
+ * "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
- * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
+ * 4. The names "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
- * from this software without prior written permission. For written
+ * from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache"
@@ -55,27 +59,32 @@
*
* [Additional notices, if required by prior licensing conditions]
*
- */
+ */
package org.apache.commons.latka.http;
import java.util.List;
+/**
+ * Manage a set of http request headers
+ *
+ * @author Morgan Delagrange
+ * @author dIon Gillard
+ * @version $Id: RequestHeaders.java,v 1.3 2002/04/11 02:34:53 dion Exp $
+ */
public interface RequestHeaders {
/**
* Add a header to the request
- *
* @param headerName header name
- * @param headerValue
- * header value, or null for an empty value
+ * @param headerValue header value, or null for an empty value
*/
public void addHeader(String headerName, String headerValue);
+
/**
- * Returns a list of all the headers for the request.
+ * Return a list of all the headers for the request.
* Elements of the list are a String array with the
* headerName as the first value and the header value
* as the second (can be null).
- *
* @return all headers for the request
*/
public List getHeaders();
1.12 +11 -7
jakarta-commons/latka/src/java/org/apache/commons/latka/http/Request.java
Index: Request.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/latka/src/java/org/apache/commons/latka/http/Request.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- Request.java 2 Feb 2002 12:56:21 -0000 1.11
+++ Request.java 11 Apr 2002 02:34:53 -0000 1.12
@@ -1,9 +1,13 @@
/*
+ *
+ *
+ *
+ *
* ====================================================================
*
* The Apache Software License, Version 1.1
*
- * Copyright (c) 1999 The Apache Software Foundation. All rights
+ * Copyright (c) 1999-2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -11,7 +15,7 @@
* are met:
*
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
+ * notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
@@ -19,15 +23,15 @@
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
- * any, must include the following acknowlegement:
- * "This product includes software developed by the
+ * any, must include the following acknowlegement:
+ * "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
- * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
+ * 4. The names "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
- * from this software without prior written permission. For written
+ * from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache"
@@ -55,7 +59,7 @@
*
* [Additional notices, if required by prior licensing conditions]
*
- */
+ */
package org.apache.commons.latka.http;
1.3 +50 -26
jakarta-commons/latka/src/java/org/apache/commons/latka/http/RequestHeadersImpl.java
Index: RequestHeadersImpl.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/latka/src/java/org/apache/commons/latka/http/RequestHeadersImpl.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- RequestHeadersImpl.java 20 Jan 2002 00:03:41 -0000 1.2
+++ RequestHeadersImpl.java 11 Apr 2002 02:34:53 -0000 1.3
@@ -1,9 +1,13 @@
/*
+ *
+ *
+ *
+ *
* ====================================================================
*
* The Apache Software License, Version 1.1
*
- * Copyright (c) 1999 The Apache Software Foundation. All rights
+ * Copyright (c) 1999-2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -11,7 +15,7 @@
* are met:
*
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
+ * notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
@@ -19,15 +23,15 @@
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
- * any, must include the following acknowlegement:
- * "This product includes software developed by the
+ * any, must include the following acknowlegement:
+ * "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
- * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
+ * 4. The names "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
- * from this software without prior written permission. For written
+ * from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache"
@@ -55,31 +59,51 @@
*
* [Additional notices, if required by prior licensing conditions]
*
- */
+ */
package org.apache.commons.latka.http;
import java.util.LinkedList;
import java.util.List;
+/**
+ * Implementation of {@link RequestHeaders} that stores its name-value pairs
+ * in a list
+ *
+ * @author Morgran Delagrange
+ * @author dIon Gillard
+ * @version $Id: RequestHeadersImpl.java,v 1.3 2002/04/11 02:34:53 dion Exp $
+ */
public class RequestHeadersImpl implements RequestHeaders {
- protected List _list = new LinkedList();
-
- /**
- * Protected access, headers can only be copied from
- * request to request.
- */
- protected RequestHeadersImpl() {
- }
-
- // defined in interface
- public void addHeader(String headerName, String headerValue) {
- _list.add(new String[] { headerName, headerValue });
- }
-
- // defined in interface
- public List getHeaders() {
- return _list;
- }
-
+ /**
+ * The list of headers. Each element is a string array of two elements;
+ * the header name and value.
+ */
+ protected List _list = new LinkedList();
+
+ /**
+ * Protected access, headers can only be copied from
+ * request to request.
+ */
+ protected RequestHeadersImpl() {
+ }
+
+ /**
+ * Defined in interface
+ * @param headerName name of the header to be added
+ * @param headerValue value of the header to be added
+ * @see RequestHeaders#addHeader(String,String)
+ */
+ public void addHeader(String headerName, String headerValue) {
+ _list.add(new String[] { headerName, headerValue });
+ }
+
+ /**
+ * Defined in interface
+ * @return a list of headers
+ * @see RequestHeaders#getHeaders()
+ */
+ public List getHeaders() {
+ return _list;
+ }
}
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
