MessageLogin: refactor variable names, add javadocs

diff --git a/src/uk/ac/ntu/n0521366/wsyd/libs/message/MessageLogin.java b/src/uk/ac/ntu/n0521366/wsyd/libs/message/MessageLogin.java
index 6c58f52..1b11570 100644 (file)
--- a/src/uk/ac/ntu/n0521366/wsyd/libs/message/MessageLogin.java
+++ b/src/uk/ac/ntu/n0521366/wsyd/libs/message/MessageLogin.java
@@ -1,7 +1,7 @@
 /*
  * The MIT License
  *
- * Copyright 2015 eddie.
+ * Copyright 2015 Eddie Berrisford-Lynch <dev@fun2be.me>.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -28,7 +28,7 @@ import java.io.Serializable;
 /**
  * Message used to authenticate a login with the SocialServer.
  *
- * @author eddie
+ * @author Eddie Berrisford-Lynch <dev@fun2be.me>
  */
 public class MessageLogin extends MessageAbstract implements Serializable {
     
@@ -40,12 +40,12 @@ public class MessageLogin extends MessageAbstract implements Serializable {
     /**
      * A Username.
      */
-    public final String _uName;
+    public final String _userName;
     
     /**
      * A password.
      */
-    public final String _uPass;
+    public final String _userPassword;
     
     /**
      * After login the user's ID.
@@ -62,12 +62,12 @@ public class MessageLogin extends MessageAbstract implements Serializable {
      * 
      * @return human readable text
      */
+    @Override
     public String toString() {
-        return new String("_uName:" + _uName + 
-                          ",_uPass:" + _uPass +
-                          ",_userID:" + _userID +
-                          ",_loggedIn:" + _loggedIn
-        );
+        return  "_uName:" + _userName + 
+                ",_uPass:" + _userPassword +
+                ",_userID:" + _userID +
+                ",_loggedIn:" + _loggedIn;
     }
     
     /** 
@@ -79,14 +79,21 @@ public class MessageLogin extends MessageAbstract implements Serializable {
         return _type;
     }
     
+    /**
+     * The purpose of this class of message.
+     * 
+     * @return "Login"
+     */
     @Override
     public String getMessageType() {
         return _type;
     }
     
+    /**
+     * Default constructor.
+     */
     public MessageLogin() {
-        this._uName = null;
-        this._uPass = null;
+        this(null, null);
     }
     
     /**
@@ -96,7 +103,8 @@ public class MessageLogin extends MessageAbstract implements Serializable {
      * @param uPass Password
      */
     public MessageLogin (String uName, String uPass) {
-        this._uName = uName;
-        this._uPass = uPass;
+        super();
+        this._userName = uName;
+        this._userPassword = uPass;
     }  
 }