dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 19426
committer: Lars Helge Overland <larshelge@xxxxxxxxx>
branch nick: dhis2
timestamp: Tue 2015-06-16 19:57:23 +0200
message:
  Javadoc
modified:
  dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/AppendingHashMap.java
  dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/ListUtils.java
  dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/LoggingHashMap.java
  dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/MimicingHashMap.java
  dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/PaginatedList.java
  dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/UniqueArrayList.java
  dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/filter/Filter.java
  dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/filter/FilterUtils.java
  dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/functional/Function0.java
  dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/timer/SystemTimer.java
  dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/timer/Timer.java
  dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/Clock.java
  dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/ConversionUtils.java
  dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/CsvUtils.java
  dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/DebugUtils.java
  dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/PageRange.java
  dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/StreamUtils.java
  dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/UUIdUtils.java


--
lp:dhis2
https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk

Your team DHIS 2 developers is subscribed to branch lp:dhis2.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk/+edit-subscription

=== modified file 'dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/AppendingHashMap.java'
--- dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/AppendingHashMap.java	2015-06-15 13:44:20 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/AppendingHashMap.java	2015-06-16 17:57:23 +0000
@@ -35,7 +35,6 @@
  * inserted, or inserts as usual if no entries match the key.
  * 
  * @author Lars Helge Overland
- * @version $Id$
  */
 public class AppendingHashMap<K, V>
     extends HashMap<K, String>

=== modified file 'dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/ListUtils.java'
--- dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/ListUtils.java	2015-06-15 13:44:20 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/ListUtils.java	2015-06-16 17:57:23 +0000
@@ -40,6 +40,8 @@
 import org.apache.commons.lang3.StringUtils;
 
 /**
+ * Utility methods for list operations.
+ * 
  * @author Lars Helge Overland
  */
 public class ListUtils

=== modified file 'dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/LoggingHashMap.java'
--- dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/LoggingHashMap.java	2015-06-15 13:44:20 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/LoggingHashMap.java	2015-06-16 17:57:23 +0000
@@ -38,7 +38,6 @@
  * HashMap that logs the key if the requested value is null.
  * 
  * @author Lars Helge Overland
- * @version $Id$
  */
 public class LoggingHashMap<K, V>
     extends HashMap<K, V>

=== modified file 'dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/MimicingHashMap.java'
--- dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/MimicingHashMap.java	2015-06-15 13:44:20 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/MimicingHashMap.java	2015-06-16 17:57:23 +0000
@@ -34,7 +34,6 @@
  * HashMap that returns as value the given key.
  * 
  * @author Lars Helge Overland
- * @version $Id$
  */
 public class MimicingHashMap<K, V>
     extends HashMap<K, V>

=== modified file 'dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/PaginatedList.java'
--- dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/PaginatedList.java	2015-06-15 13:44:20 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/PaginatedList.java	2015-06-16 17:57:23 +0000
@@ -33,6 +33,8 @@
 import java.util.List;
 
 /**
+ * List implementation that provides a paged view.
+ * 
  * @author Lars Helge Overland
  */
 public class PaginatedList<T>

=== modified file 'dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/UniqueArrayList.java'
--- dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/UniqueArrayList.java	2015-06-15 13:44:20 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/UniqueArrayList.java	2015-06-16 17:57:23 +0000
@@ -32,6 +32,9 @@
 import java.util.Collection;
 
 /**
+ * List implementation that will only add items which are not already present in
+ * the list.
+ * 
  * @author Lars Helge Overland
  */
 public class UniqueArrayList<E>

=== modified file 'dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/filter/Filter.java'
--- dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/filter/Filter.java	2015-05-28 18:23:26 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/filter/Filter.java	2015-06-16 17:57:23 +0000
@@ -29,9 +29,16 @@
  */
 
 /**
+ * Filter interface.
+ * 
  * @author Lars Helge Overland
  */
 public interface Filter<T>
 {
+    /**
+     * Indicates whether the given object to should be retained in the list.
+     * 
+     * @param object the object.
+     */
     boolean retain( T object );
 }

=== modified file 'dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/filter/FilterUtils.java'
--- dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/filter/FilterUtils.java	2015-06-15 13:44:20 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/filter/FilterUtils.java	2015-06-16 17:57:23 +0000
@@ -34,6 +34,8 @@
 import java.util.Iterator;
 
 /**
+ * Utility class for collection filtering.
+ * 
  * @author Lars Helge Overland
  */
 public class FilterUtils

=== modified file 'dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/functional/Function0.java'
--- dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/functional/Function0.java	2015-06-15 13:44:20 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/functional/Function0.java	2015-06-16 17:57:23 +0000
@@ -30,6 +30,7 @@
 
 /**
  * Function with 0 parameters.
+ * 
  * @author Morten Olav Hansen <mortenoh@xxxxxxxxx>
  */
 public interface Function0

=== modified file 'dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/timer/SystemTimer.java'
--- dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/timer/SystemTimer.java	2015-05-28 18:23:26 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/timer/SystemTimer.java	2015-06-16 17:57:23 +0000
@@ -31,6 +31,8 @@
 import java.util.concurrent.TimeUnit;
 
 /**
+ * Timer implementation which uses system time.
+ * 
  * @author Morten Olav Hansen <mortenoh@xxxxxxxxx>
  */
 public class SystemTimer 

=== modified file 'dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/timer/Timer.java'
--- dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/timer/Timer.java	2015-05-28 18:23:26 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/timer/Timer.java	2015-06-16 17:57:23 +0000
@@ -29,7 +29,7 @@
  */
 
 /**
- * Simple interface that captures time, and pretty prints it back to you.
+ * Simple interface that captures time durations and pretty prints it back to you.
  *
  * @author Morten Olav Hansen <mortenoh@xxxxxxxxx>
  */

=== modified file 'dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/Clock.java'
--- dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/Clock.java	2015-06-15 13:44:20 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/Clock.java	2015-06-16 17:57:23 +0000
@@ -35,6 +35,7 @@
 
 /**
  * Utility class providing stopwatch-like functionality.
+ * 
  * @author Lars Helge Overland
  */
 public class Clock

=== modified file 'dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/ConversionUtils.java'
--- dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/ConversionUtils.java	2015-06-15 13:44:20 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/ConversionUtils.java	2015-06-16 17:57:23 +0000
@@ -37,7 +37,6 @@
 
 /**
  * @author Lars Helge Overland
- * @version $Id$
  */
 public class ConversionUtils
 {

=== modified file 'dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/CsvUtils.java'
--- dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/CsvUtils.java	2015-06-15 13:44:20 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/CsvUtils.java	2015-06-16 17:57:23 +0000
@@ -30,7 +30,6 @@
 
 /**
  * @author Lars Helge Overland
- * @version $Id$
  */
 public class CsvUtils
 {

=== modified file 'dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/DebugUtils.java'
--- dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/DebugUtils.java	2015-06-15 13:44:20 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/DebugUtils.java	2015-06-16 17:57:23 +0000
@@ -40,7 +40,6 @@
 
 /**
  * @author Lars Helge Overland
- * @version $Id$
  */
 public class DebugUtils
 {

=== modified file 'dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/PageRange.java'
--- dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/PageRange.java	2015-06-15 13:44:20 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/PageRange.java	2015-06-16 17:57:23 +0000
@@ -1,8 +1,5 @@
 package org.hisp.dhis.commons.util;
 
-import java.util.ArrayList;
-import java.util.List;
-
 /*
  * Copyright (c) 2004-2015, University of Oslo
  * All rights reserved.
@@ -31,6 +28,9 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+import java.util.ArrayList;
+import java.util.List;
+
 /**
  * @author Lars Helge Overland
  */

=== modified file 'dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/StreamUtils.java'
--- dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/StreamUtils.java	2015-06-15 13:44:20 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/StreamUtils.java	2015-06-16 17:57:23 +0000
@@ -60,7 +60,6 @@
 
 /**
  * @author Lars Helge Overland
- * @version $Id$
  */
 public class StreamUtils
 {

=== modified file 'dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/UUIdUtils.java'
--- dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/UUIdUtils.java	2015-06-15 13:44:20 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/util/UUIdUtils.java	2015-06-16 17:57:23 +0000
@@ -32,7 +32,6 @@
 
 /**
  * @author Lars Helge Overland
- * @version $Id$
  */
 public class UUIdUtils
 {