geronimo-scm mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jgenen...@apache.org
Subject svn commit: r579034 - in /geronimo/sandbox/AsyncHttpClient: pom.xml src/main/java/org/apache/ahc/codec/Cookie.java src/main/java/org/apache/ahc/package.html src/main/javadoc/ src/main/javadoc/overview.html
Date Tue, 25 Sep 2007 02:06:00 GMT
Author: jgenender
Date: Mon Sep 24 19:05:59 2007
New Revision: 579034

URL: http://svn.apache.org/viewvc?rev=579034&view=rev
Log:
Starting the javadoc :P

Added:
    geronimo/sandbox/AsyncHttpClient/src/main/java/org/apache/ahc/package.html
    geronimo/sandbox/AsyncHttpClient/src/main/javadoc/
    geronimo/sandbox/AsyncHttpClient/src/main/javadoc/overview.html
Modified:
    geronimo/sandbox/AsyncHttpClient/pom.xml
    geronimo/sandbox/AsyncHttpClient/src/main/java/org/apache/ahc/codec/Cookie.java

Modified: geronimo/sandbox/AsyncHttpClient/pom.xml
URL: http://svn.apache.org/viewvc/geronimo/sandbox/AsyncHttpClient/pom.xml?rev=579034&r1=579033&r2=579034&view=diff
==============================================================================
--- geronimo/sandbox/AsyncHttpClient/pom.xml (original)
+++ geronimo/sandbox/AsyncHttpClient/pom.xml Mon Sep 24 19:05:59 2007
@@ -1,19 +1,19 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!--
-    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
+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
+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.
+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.
 -->
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
@@ -92,6 +92,14 @@
             <version>1.3</version>
         </dependency>
     </dependencies>
+    <reporting>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </reporting>
     <build>
         <plugins>
             <plugin>

Modified: geronimo/sandbox/AsyncHttpClient/src/main/java/org/apache/ahc/codec/Cookie.java
URL: http://svn.apache.org/viewvc/geronimo/sandbox/AsyncHttpClient/src/main/java/org/apache/ahc/codec/Cookie.java?rev=579034&r1=579033&r2=579034&view=diff
==============================================================================
--- geronimo/sandbox/AsyncHttpClient/src/main/java/org/apache/ahc/codec/Cookie.java (original)
+++ geronimo/sandbox/AsyncHttpClient/src/main/java/org/apache/ahc/codec/Cookie.java Mon Sep
24 19:05:59 2007
@@ -21,6 +21,10 @@
 
 import java.util.Date;
 
+/**
+ * Class is the container for an HTTP Cookie. It is an object representing the cookie header
of
+ * the HTTP protocol.
+ */
 public class Cookie {
 
     private String comment;
@@ -32,47 +36,94 @@
     private int version;
     private Date expires;
 
+    /**
+     * Constructs a cookie identified by a name and value.
+     *
+     * @param name the cookie name
+     * @param value the cookie value
+     */
     public Cookie(String name, String value) {
         this.name = name;
         this.value = value;
     }
 
+    /**
+     * Returns a cookie's comment or <code>null</code> if no comment exists.
+     * @return The cookie comment
+     */
     public String getComment() {
         return comment;
     }
 
+    /**
+     * Sets a comment which describes the cookie.
+     * @param comment the comment to set
+     */
     public void setComment(String comment) {
         this.comment = comment;
     }
 
+    /**
+     * Returns a cookie's domain is one is available or <code>null</code> if
it does not exist.
+     * @return the cookie's domain.
+     */
     public String getDomain() {
         return domain;
     }
 
+    /**
+     * Sets a cookie's domain as specified by RFC 2109
+     * @param domain the cookie's domain to set
+     */
     public void setDomain(String domain) {
         this.domain = domain;
     }
 
+
+    /**
+     * Returns the name of the cookie
+     * @return the name of the cookie
+     */
     public String getName() {
         return name;
     }
 
+    /**
+     * Sets the name of the cookie
+     * @param name the name of the cookie
+     */
     public void setName(String name) {
         this.name = name;
     }
 
+    /**
+     * Returns the cookie's value
+     * @return the cookie's value
+     */
     public String getValue() {
         return value;
     }
 
+    /**
+     * Sets the cookie's value
+     * @param value the cookie value
+     */
     public void setValue(String value) {
         this.value = value;
     }
 
+    /**
+     * Returns the cookie path. The path represents all paths, and sub-paths that this cookie
is valid.
+     * @return the cookie path
+     */
     public String getPath() {
         return path;
     }
 
+    /**
+     * Set the cookie's path. The path represents all paths, and sub-paths that this cookie
is valid.
+     * @param path the cookie path
+     */
     public void setPath(String path) {
         this.path = path;
     }

Added: geronimo/sandbox/AsyncHttpClient/src/main/java/org/apache/ahc/package.html
URL: http://svn.apache.org/viewvc/geronimo/sandbox/AsyncHttpClient/src/main/java/org/apache/ahc/package.html?rev=579034&view=auto
==============================================================================
--- geronimo/sandbox/AsyncHttpClient/src/main/java/org/apache/ahc/package.html (added)
+++ geronimo/sandbox/AsyncHttpClient/src/main/java/org/apache/ahc/package.html Mon Sep 24
19:05:59 2007
@@ -0,0 +1,26 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+  ~  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.
+  -->
+</head>
+<body bgcolor="white">
+<h2>The primary user components for the AsyncHttpClient API</h2>
+</body>
+</html>

Added: geronimo/sandbox/AsyncHttpClient/src/main/javadoc/overview.html
URL: http://svn.apache.org/viewvc/geronimo/sandbox/AsyncHttpClient/src/main/javadoc/overview.html?rev=579034&view=auto
==============================================================================
--- geronimo/sandbox/AsyncHttpClient/src/main/javadoc/overview.html (added)
+++ geronimo/sandbox/AsyncHttpClient/src/main/javadoc/overview.html Mon Sep 24 19:05:59 2007
@@ -0,0 +1,31 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+  ~  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.
+  -->
+    <title>The AsyncHttpClient is a high performance HTTP client API that is based
on the Java NIO networking
+API.</title>
+</head>
+<body bgcolor="white">
+<h1>The AsyncHttpClient is a high performance HTTP client API that is based on the
Java NIO networking
+API.</h1>
+This API is based on the <a href="http://mina.apache.org">Apache MINA</a> framework
to provide a high
+performance networking library based on the HTTP protocol.
+</body>
+</html>



Mime
View raw message