abdera-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jmsn...@apache.org
Subject svn commit: r632974 - /incubator/abdera/java/trunk/protocol/src/main/java/org/apache/abdera/protocol/Response.java
Date Mon, 03 Mar 2008 07:55:01 GMT
Author: jmsnell
Date: Sun Mar  2 23:55:00 2008
New Revision: 632974

URL: http://svn.apache.org/viewvc?rev=632974&view=rev
Log:
javadocs

Modified:
    incubator/abdera/java/trunk/protocol/src/main/java/org/apache/abdera/protocol/Response.java

Modified: incubator/abdera/java/trunk/protocol/src/main/java/org/apache/abdera/protocol/Response.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/protocol/src/main/java/org/apache/abdera/protocol/Response.java?rev=632974&r1=632973&r2=632974&view=diff
==============================================================================
--- incubator/abdera/java/trunk/protocol/src/main/java/org/apache/abdera/protocol/Response.java
(original)
+++ incubator/abdera/java/trunk/protocol/src/main/java/org/apache/abdera/protocol/Response.java
Sun Mar  2 23:55:00 2008
@@ -22,9 +22,15 @@
 import org.apache.abdera.i18n.iri.IRI;
 import org.apache.abdera.util.EntityTag;
 
+/**
+ * Base interface for an Atompub protocol response message
+ */
 public interface Response
   extends Message {
 
+  /**
+   * High level classifications of response types
+   */
   public static enum ResponseType {
     SUCCESS, REDIRECTION, CLIENT_ERROR, SERVER_ERROR, UNKNOWN;
     
@@ -38,34 +44,76 @@
     
   }
   
+  /**
+   * Get the Entity Tag returned by the server
+   */
   EntityTag getEntityTag();
     
+  /**
+   * Get the response type classification
+   */
   ResponseType getType();
   
+  /**
+   * Get the specific response status code
+   */
   int getStatus();
   
+  /**
+   * Get the response status text
+   */
   String getStatusText();
   
+  /**
+   * Get the value of the Last-Modified response header
+   */
   Date getLastModified();
   
+  /**
+   * Get the value of the Content-Length response header
+   */
   long getContentLength();
   
+  /**
+   * Get the value of the Allow response header
+   */
   String getAllow();
   
+  /**
+   * Get the value of the Location response header
+   */
   IRI getLocation();
   
+  /**
+   * True if the Cache-Control header specifies the private directive
+   */
   boolean isPrivate();
   
+  /**
+   * True if the Cache-Control header specified the public directive
+   */
   boolean isPublic();
   
+  /**
+   * True if the Cache-Control header specifies the must-revalidate directive
+   */
   boolean isMustRevalidate();
   
+  /**
+   * True if the Cache-Control header specifies the proxy-revalidate directive
+   */
   boolean isProxyRevalidate();
   
   long getSMaxAge();
   
+  /**
+   * Get the age of this response as specified by the server
+   */
   long getAge();
   
+  /**
+   * Get the date/time this response expires
+   */
   Date getExpires();
   
   String[] getNoCacheHeaders();



Mime
View raw message