[AJ-109] Finished Javadoc

Author: srt

ANNOUNCEMENT

@@ -1,6 +1,6 @@
 ANNOUNCEMENT: Asterisk-Java 0.3.1 released
 
-Asterisk-Java 0.3.1, a free Java library for Asterisk PBX integration,
+Asterisk-Java 0.3.1, the free Java library for Asterisk PBX integration,
 has been released.
 
 The Asterisk-Java package consists of a set of Java classes that allow
@@ -16,7 +16,7 @@ following issues:
     * [AJ-68] - Support for Bridge Action
     * [AJ-74] - Support Strategy property in QueueParamsEvent
 
-Asterisk-Java takes advantage of the features of Java 5.0 and therfore
+Asterisk-Java takes advantage of the features of Java 5.0 and therefore
 requires a Java Virtual Machine of at least version 1.5.0.
 
 Asterisk-Java is used in several commercial environments and by

src/main/java/org/asteriskjava/AsteriskVersion.java

@@ -57,7 +57,7 @@ public class AsteriskVersion implements Comparable<AsteriskVersion>, Serializabl
     /**
      * Serial version identifier.
      */
-    private static final long serialVersionUID = -5696160640576385797L;
+    private static final long serialVersionUID = 1L;
 
     private AsteriskVersion(int version, String versionString)
     {

src/main/java/org/asteriskjava/manager/event/AgiExecEvent.java

@@ -3,7 +3,7 @@
 /**
  * AgiExecEvents are triggered when an AGI command is executed. For each command two events are triggered:
  * one before excution ("Start") and one after execution ("End").
- * <p>
+ * <p/>
  * The following sub events are reported:
  * <ul>
  * <li>Start: Execution of an AGI command has started.</li>
@@ -39,6 +39,7 @@ public class AgiExecEvent extends ManagerEvent
     private String commandId;
     private String command;
     private Integer resultCode;
+    private String result;
 
     /**
      * Creates a new AgiExecEvent.
@@ -74,6 +75,8 @@ public void setChannel(String channel)
      * Returns the sub event type. This is either "Start" or "End".
      *
      * @return the sub event type.
+     * @see #SUB_EVENT_START
+     * @see #SUB_EVENT_END
      */
     public String getSubEvent()
     {
@@ -131,16 +134,55 @@ public void setCommand(String command)
         this.command = command;
     }
 
+    /**
+     * Returns the result code.
+     *
+     * @return the result code.
+     */
     public Integer getResultCode()
     {
         return resultCode;
     }
 
+    /**
+     * Sets the result code.
+     *
+     * @param resultCode the result code.
+     */
     public void setResultCode(Integer resultCode)
     {
         this.resultCode = resultCode;
     }
 
+    /**
+     * Returns the result as a string.<p>
+     * They correspond to the numeric values returned by {@link #getResultCode()}. Usually you will want to
+     * stick with the numeric values.<p>
+     * Possible values are:
+     * <ul>
+     * <li>Failure (corresponds to result code -1)</li>
+     * <li>Success (corresponds to result code 200)</li>
+     * <li>KeepAlive (corresponds to result code 210)</li>
+     * <li>Command not permitted on a dead channel (corresponds to result code 511)</li>
+     * <li>Usage (corresponds to result code 520)</li>
+     * </ul>
+     *
+     * @return a string respresentation of the result.
+     */
+    public String getResult()
+    {
+        return result;
+    }
+
+    /**
+     * Sets the string respresentation of the result.
+     *
+     * @param result a string respresentation of the result.
+     */
+    public void setResult(String result)
+    {
+        this.result = result;
+    }
 
     /**
      * Checks is this a start sub event.

src/main/java/org/asteriskjava/manager/event/AsyncAgiEvent.java

@@ -122,7 +122,7 @@ public void setCommandId(String commandId)
      * 200%20result%3d0
      * </pre>
      *
-     * @return the result.
+     * @return the URL encoded result.
      */
     public String getResult()
     {
@@ -155,7 +155,7 @@ public String decodeResult()
     /**
      * Sets the raw result.
      *
-     * @param result the result.
+     * @param result the URL encoded result.
      */
     public void setResult(String result)
     {
@@ -178,7 +178,7 @@ public void setResult(String result)
      * ...
      * </pre>
      *
-     * @return the AGI environment.
+     * @return the URL encoded AGI environment.
      */
     public String getEnv()
     {
@@ -227,7 +227,7 @@ public Map<String, String> decodeEnv()
     /**
      * Sets the AGI environment.
      *
-     * @param env the AGI environment.
+     * @param env the URL encoded AGI environment.
      */
     public void setEnv(String env)
     {
@@ -268,5 +268,4 @@ protected boolean isSubEvent(String subEvent)
     {
         return this.subEvent != null && this.subEvent.equalsIgnoreCase(subEvent);
     }
-
 }

src/main/java/org/asteriskjava/util/DaemonThreadFactory.java

@@ -5,7 +5,7 @@
 import java.util.concurrent.atomic.AtomicInteger;
 
 /**
- * A ThreadFactory that creates daemon threads for use with an {@link Executor}
+ * A ThreadFactory that creates daemon threads for use with an {@link Executor}.
  * 
  * @author srt
  * @version $Id$

src/main/java/org/asteriskjava/util/LogFactory.java

@@ -71,7 +71,7 @@ public static Log getLog(Class clazz)
                 log4jLoggingAvailable = Boolean.FALSE;
             }
         }
-        if (log4jLoggingAvailable.booleanValue())
+        if (log4jLoggingAvailable)
         {
             return new Log4JLogger(clazz);
         }
@@ -89,7 +89,7 @@ public static Log getLog(Class clazz)
                     javaLoggingAvailable = Boolean.FALSE;
                 }
             }
-            if (javaLoggingAvailable.booleanValue())
+            if (javaLoggingAvailable)
             {
                 return new JavaLoggingLog(clazz);
             }

src/main/java/org/asteriskjava/util/ReflectionUtil.java

@@ -50,11 +50,10 @@ public static Map<String, Method> getGetters(final Class clazz)
         final Map<String, Method> accessors = new HashMap<String, Method>();
         final Method[] methods = clazz.getMethods();
 
-        for (int i = 0; i < methods.length; i++)
+        for (Method method : methods)
         {
             String name;
             String methodName;
-            final Method method = methods[i];
 
             methodName = method.getName();
             if (!methodName.startsWith("get"))
@@ -97,11 +96,10 @@ public static Map<String, Method> getSetters(Class clazz)
         final Map<String, Method> accessors = new HashMap<String, Method>();
         final Method[] methods = clazz.getMethods();
 
-        for (int i = 0; i < methods.length; i++)
+        for (Method method : methods)
         {
             String name;
             String methodName;
-            Method method = methods[i];
 
             methodName = method.getName();
             if (!methodName.startsWith("set"))

src/main/java/org/asteriskjava/util/SocketConnectionFacade.java

@@ -33,9 +33,11 @@ public interface SocketConnectionFacade
     /**
      * Reads a line of text from the socket connection. The current thread is
      * blocked until either the next line is received or an IOException
-     * encounters.
+     * encounters.<p>
+     * Depending on the implementation different newline delimiters are used
+     * ("\r\n" for the Manager API and "\n" for AGI).
      * 
-     * @return the line of text received excluding any newline character
+     * @return the line of text received excluding the newline delimiter.
      * @throws IOException if the connection has been closed.
      */
     String readLine() throws IOException;
@@ -50,7 +52,7 @@ public interface SocketConnectionFacade
     void write(String s) throws IOException;
 
     /**
-     * Flushes the socket connection, that is sends any buffered but yet unsent
+     * Flushes the socket connection by sending any buffered but yet unsent
      * data.
      * 
      * @throws IOException if the connection cannot be flushed.