commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From marcs...@apache.org
Subject cvs commit: jakarta-commons/httpclient/src/java/org/apache/commons/httpclient Cookie.java
Date Sun, 24 Feb 2002 17:28:53 GMT
marcsaeg    02/02/24 09:28:53

  Modified:    httpclient/src/java/org/apache/commons/httpclient
                        Cookie.java
  Log:
  Improved JavaDoc comments.
  
  Submitted by:  Sean C. Sullivan [sean@seansullivan.com]
  
  Revision  Changes    Path
  1.15      +29 -11    jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/Cookie.java
  
  Index: Cookie.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/Cookie.java,v
  retrieving revision 1.14
  retrieving revision 1.15
  diff -u -r1.14 -r1.15
  --- Cookie.java	22 Feb 2002 19:13:51 -0000	1.14
  +++ Cookie.java	24 Feb 2002 17:28:53 -0000	1.15
  @@ -1,7 +1,7 @@
   /*
  - * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/Cookie.java,v
1.14 2002/02/22 19:13:51 marcsaeg Exp $
  - * $Revision: 1.14 $
  - * $Date: 2002/02/22 19:13:51 $
  + * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/Cookie.java,v
1.15 2002/02/24 17:28:53 marcsaeg Exp $
  + * $Revision: 1.15 $
  + * $Date: 2002/02/24 17:28:53 $
    * ====================================================================
    *
    * The Apache Software License, Version 1.1
  @@ -87,8 +87,9 @@
    * @author <a href="mailto:dsale@us.britannica.com">Doug Sale</a>
    * @author Rod Waldhoff
    * @author dIon Gillard
  + * @author Sean C. Sullivan
    * @author <a href="mailto:JEvans@Cyveillance.com">John Evans</a>
  - * @version $Revision: 1.14 $ $Date: 2002/02/22 19:13:51 $
  + * @version $Revision: 1.15 $ $Date: 2002/02/24 17:28:53 $
    */
   
   public class Cookie extends NameValuePair implements Serializable, Comparator {
  @@ -167,6 +168,9 @@
        * considered immutable. Changing it (e.g. using setTime()) could result
        * in undefined behaviour. Do so at your peril. </p>
        * @return my expiration {@link Date}, or <tt>null</tt>.
  +     *
  +     * @see #setExpiryDate(java.util.Date)
  +     *
        */
       public Date getExpiryDate() {
           return _expiryDate;
  @@ -188,7 +192,11 @@
        * <p><strong>Note:</strong> the object returned by this method is
considered
        * immutable. Changing it (e.g. using setTime()) could result in undefined 
        * behaviour. Do so at your peril.</p>
  +     *
        * @param expiryDate the {@link Date} after which this cookie is no longer valid.
  +     *
  +     * @see #getExpiryDate
  +     *
        */
       public void setExpiryDate (Date expiryDate) {
           _expiryDate = expiryDate;
  @@ -240,7 +248,7 @@
   
   
       /**
  -     * Return my path.
  +     * @return my path.
        * @see #setPath(java.lang.String)
        */
       public String getPath() {
  @@ -253,14 +261,17 @@
        * I should be presented only with requests beginning with this path.
        * See RFC 2109 for a specification of the default behaviour. Basically, URLs
        * in the same "directory" as the one which set the cookie, and in subdirectories,
  -     * can all see the cookie unless a different path is set.
  +     * can all see the cookie unless a different path is set.</p>
  +     *
  +     * @see #getPath
  +     *
        */
       public void setPath(String path) {
           _path = path;
       }
   
       /**
  -     * Return whether this cookie should only be sent over secure connections.
  +     * @return <code>true</code> if this cookie should only be sent over secure
connections.
        * @see #setSecure(boolean)
        */
       public boolean getSecure() {
  @@ -282,7 +293,11 @@
       }
   
       /**
  -     * Return the version of the HTTP cookie specification I use.
  +     *
  +     * @return the version of the HTTP cookie specification that I use.
  +     * 
  +     * @see #setVersion(int)
  +     *
        */
       public int getVersion() {
           return _version;
  @@ -292,14 +307,17 @@
        * Set the version of the HTTP cookie specification I report.
        * <p>
        * The current implementation only sends version 1 cookies.
  -     * (See RFC 2109 for details.)
  +     * (See RFC 2109 for details.)</p>
  +     *
  +     * @see #getVersion
  +     *
        */
       public void setVersion(int version) {
           _version = version;
       }
   
       /**
  -     * Return <tt>true</tt> if I have expired.
  +     * 
        * @return <tt>true</tt> if I have expired.
        */
       public boolean isExpired() {
  @@ -308,7 +326,7 @@
       }
   
       /**
  -     * Return <tt>true</tt> if I have expired.
  +     * 
        * @return <tt>true</tt> if I have expired.
        */
       public boolean isExpired(Date now) {
  
  
  

--
To unsubscribe, e-mail:   <mailto:commons-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:commons-dev-help@jakarta.apache.org>


Mime
View raw message