Changeset 201 for trunk

Timestamp:

09/26/11 23:00:42 (13 years ago)

Author:

sherbold

Message:

• Code documentation and minor refactorings

Location:

trunk/JavaHelperLib/src/de/ugoe/cs/util/console

Files:

• Console.java (modified) (7 diffs)
• TextConsole.java (modified) (3 diffs)
• listener/IErrorListener.java (modified) (1 diff)
• listener/IOutputListener.java (modified) (1 diff)
• listener/ITraceListener.java (modified) (1 diff)

trunk/JavaHelperLib/src/de/ugoe/cs/util/console/Console.java

@@ -31 +31 @@
 public final class Console {
 
+        /**
+         * <p>
+         * Listeners for the output stream.
+         * </p>
+         */
         private Collection<IOutputListener> outputListener;
+
+        /**
+         * <p>
+         * Listeners for the error stream.
+         * </p>
+         */
         private Collection<IErrorListener> errorListener;
+
+        /**
+         * <p>
+         * Listeners for the trace stream.
+         * </p>
+         */
         private Collection<ITraceListener> traceListener;
+
+        /**
+         * <p>
+         * Listeners for the command stream.
+         * </p>
+         */
         private Collection<ICommandListener> commandListener;
+
+        /**
+         * <p>
+         * Listeners for the exception stream.
+         * </p>
+         */
         private Collection<IExceptionListener> exceptionListener;
 
@@ -240 +269 @@
                 }
                 for (IOutputListener observer : theInstance.outputListener) {
-                        observer.updateText(msg);
+                        observer.outputMsg(msg);
                 }
         }
@@ -258 +287 @@
                 }
                 for (IOutputListener observer : theInstance.outputListener) {
-                        observer.updateText(msg + StringTools.ENDLINE);
+                        observer.outputMsg(msg + StringTools.ENDLINE);
                 }
         }
@@ -276 +305 @@
                 }
                 for (IErrorListener observer : theInstance.errorListener) {
-                        observer.errStream(errMsg);
+                        observer.errorMsg(errMsg);
                 }
         }
@@ -294 +323 @@
                 }
                 for (IErrorListener observer : theInstance.errorListener) {
-                        observer.errStream(errMsg + StringTools.ENDLINE);
+                        observer.errorMsg(errMsg + StringTools.ENDLINE);
                 }
         }
@@ -329 +358 @@
                 }
                 for (ITraceListener observer : theInstance.traceListener) {
-                        observer.trace(traceMsg);
+                        observer.traceMsg(traceMsg);
                 }
         }
@@ -348 +377 @@
                 }
                 for (ITraceListener observer : theInstance.traceListener) {
-                        observer.trace(traceMsg + StringTools.ENDLINE);
+                        observer.traceMsg(traceMsg + StringTools.ENDLINE);
                 }
         }

trunk/JavaHelperLib/src/de/ugoe/cs/util/console/TextConsole.java

@@ -44 +44 @@
          * </p>
          * 
-         * @see ConsoleObserver#updateText(java.lang.String)
+         * @see ConsoleObserver#outputMsg(java.lang.String)
          */
-        public void updateText(String newMessage) {
+        public void outputMsg(String newMessage) {
                 System.out.print(newMessage);
         }
@@ -55 +55 @@
          * </p>
          * 
-         * @see ConsoleObserver#errStream(String)
+         * @see ConsoleObserver#errorMsg(String)
          */
         @Override
-        public void errStream(String errMessage) {
+        public void errorMsg(String errMessage) {
                 System.err.print(errMessage);
         }
@@ -81 +81 @@
          */
         @Override
-        public void trace(String traceMessage) {
+        public void traceMsg(String traceMessage) {
                 if (debugMode) {
                         System.out.print(traceMessage);

trunk/JavaHelperLib/src/de/ugoe/cs/util/console/listener/IErrorListener.java

@@ -18 +18 @@
          * </p>
          * 
-         * TODO: rename method to errorMsg()
-         * 
          * @param errMessage
          *            error message
          */
-        public void errStream(String errMessage);
+        public void errorMsg(String errMessage);
 }

trunk/JavaHelperLib/src/de/ugoe/cs/util/console/listener/IOutputListener.java

@@ -18 +18 @@
          * </p>
          * 
-         * TODO: rename method to outputMsg()
-         * 
          * @param newMessage
          *            message that was send to the console.
          */
-        public void updateText(String newMessage);
+        public void outputMsg(String newMessage);
 
 }

trunk/JavaHelperLib/src/de/ugoe/cs/util/console/listener/ITraceListener.java

@@ -17 +17 @@
          * </p>
          * 
-         * TODO: rename method to traceMsg()
-         * 
          * @param traceMesssage
          *            error message
          */
-        public void trace(String traceMessage);
+        public void traceMsg(String traceMessage);
 }