svn commit: r125724 - /geronimo/trunk/specs/javamail/src/java/javax/mail/Header.java

[jb...@apache.org]

Author: jboynes
Date: Wed Jan 19 22:11:12 2005
New Revision: 125724

URL: http://svn.apache.org/viewcvs?view=rev&rev=125724
Log:
javadoc and stick with naming conventions
Modified:
   geronimo/trunk/specs/javamail/src/java/javax/mail/Header.java

Modified: geronimo/trunk/specs/javamail/src/java/javax/mail/Header.java
Url: http://svn.apache.org/viewcvs/geronimo/trunk/specs/javamail/src/java/javax/mail/Header.java?view=diff&rev=125724&p1=geronimo/trunk/specs/javamail/src/java/javax/mail/Header.java&r1=125723&p2=geronimo/trunk/specs/javamail/src/java/javax/mail/Header.java&r2=125724
==============================================================================
--- geronimo/trunk/specs/javamail/src/java/javax/mail/Header.java	(original)
+++ geronimo/trunk/specs/javamail/src/java/javax/mail/Header.java	Wed Jan 19 22:11:12 2005
@@ -18,22 +18,40 @@
 package javax.mail;
 
 /**
+ * Class representing a header field.
+ *
  * @version $Rev$ $Date$
  */
 public class Header {
-    private String _name;
-    private String _value;
+    private final String name;
+    private final String value;
 
+    /**
+     * Constructor initializing all immutable fields.
+     *
+     * @param name  the name of this header
+     * @param value the value of this header
+     */
     public Header(String name, String value) {
-        _name = name;
-        _value = value;
+        this.name = name;
+        this.value = value;
     }
 
+    /**
+     * Return the name of this header.
+     *
+     * @return the name of this header
+     */
     public String getName() {
-        return _name;
+        return name;
     }
 
+    /**
+     * Return the value of this header.
+     *
+     * @return the value of this header
+     */
     public String getValue() {
-        return _value;
+        return value;
     }
 }