svn commit: r1044337 - /httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/Header.java

[se...@apache.org]

Author: sebb
Date: Fri Dec 10 13:03:35 2010
New Revision: 1044337

URL: http://svn.apache.org/viewvc?rev=1044337&view=rev
Log:
Javadoc

Modified:
    httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/Header.java

Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/Header.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/Header.java?rev=1044337&r1=1044336&r2=1044337&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/Header.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/Header.java Fri Dec 10 13:03:35 2010
@@ -49,10 +49,26 @@ package org.apache.http;
  */
 public interface Header {
 
+    /**
+     * Get the name of the Header.
+     * 
+     * @return the name of the Header,  never {@code null}
+     */
     String getName();
 
+    /**
+     * Get the value of the Header.
+     * 
+     * @return the value of the Header,  may be {@code null}
+     */
     String getValue();
 
+    /**
+     * Parses the value.
+     * 
+     * @return an array of {@link HeaderElement} entries, may be empty, but is never {@code null}
+     * @throws ParseException
+     */
     HeaderElement[] getElements() throws ParseException;
 
 }