Add away reason to ClientInfo

Change-Id: Id43956b2fad628754196aea3782d4892f3b768a5
Reviewed-on: http://gerrit.dmdirc.com/2537
Reviewed-by: Shane Mc Cormack <shane@dmdirc.com>
Automatic-Compile: DMDirc Build Manager

src/com/dmdirc/parser/common/AwayState.java

@@ -29,10 +29,29 @@ package com.dmdirc.parser.common;
  * @since 0.6.3
  */
 public enum AwayState {
+
     /** State is unknown. */
-    UNKNOWN,
+    UNKNOWN("Unknown"),
     /** User is here. */
-    HERE,
+    HERE("Here"),
     /** User is away. */
-    AWAY;
+    AWAY("Away");
+
+    /** Friendly name for the state. */
+    private final String friendlyName;
+
+    /**
+     * Adds a friendly name to the away state.
+     * <p/>
+     * @param friendlyName Friendly name
+     */
+    AwayState(final String friendlyName) {
+        this.friendlyName = friendlyName;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String toString() {
+        return friendlyName;
+    }
 }

src/com/dmdirc/parser/common/BaseClientInfo.java

@@ -137,4 +137,10 @@ public abstract class BaseClientInfo implements ClientInfo {
         return getNickname();
     }
 
+    /** {@inheritDoc} */
+    @Override
+    public String getAwayReason() {
+        return "";
+    }
+
 }

src/com/dmdirc/parser/interfaces/ClientInfo.java

@@ -76,6 +76,13 @@ public interface ClientInfo {
      */
     AwayState getAwayState();
 
+    /**
+     * Get the Away Reason for this user.
+     *
+     * @return Known away reason for user.
+     */
+     String getAwayReason();
+
     /**
      * Retrieves a {@link Map} which can be used to store arbitrary data
      * about the client.

src/com/dmdirc/parser/irc/IRCClientInfo.java

@@ -252,11 +252,8 @@ public class IRCClientInfo implements LocalClientInfo {
         return away;
     }
 
-    /**
-     * Get the Away Reason for this user.
-     *
-     * @return Known away reason for user.
-     */
+    /** {@inheritDoc} */
+    @Override
     public String getAwayReason() {
         return awayReason;
     }