dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #40337
[Branch ~dhis2-devs-core/dhis2/trunk] Rev 20442: Commons, javadoc
------------------------------------------------------------
revno: 20442
committer: Lars Helge Overland <larshelge@xxxxxxxxx>
branch nick: dhis2
timestamp: Thu 2015-10-01 15:57:42 +0200
message:
Commons, javadoc
modified:
dhis-2/dhis-support/dhis-support-commons/pom.xml
dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/CollectionUtils.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/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/Predicate.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/pom.xml
--
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/pom.xml'
--- dhis-2/dhis-support/dhis-support-commons/pom.xml 2015-10-01 13:14:27 +0000
+++ dhis-2/dhis-support/dhis-support-commons/pom.xml 2015-10-01 13:57:42 +0000
@@ -52,15 +52,6 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.10.3</version>
- <executions>
- <execution>
- <id>attach-javadocs</id>
- <goals>
- <goal>jar</goal>
- </goals>
- </execution>
- </executions>
</plugin>
</plugins>
</build>
=== modified file 'dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/CollectionUtils.java'
--- dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/CollectionUtils.java 2015-10-01 13:31:25 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/CollectionUtils.java 2015-10-01 13:57:42 +0000
@@ -44,7 +44,7 @@
/**
* Utility methods for operations on various collections.
*
- * @author Morten Olav Hansen <mortenoh@xxxxxxxxx>
+ * @author Morten Olav Hansen
*/
public class CollectionUtils
{
@@ -91,9 +91,11 @@
/**
* Constructs a Map Entry (key, value). Used to construct a Map with asMap.
*
- * @param key map entry key
- * @param value map entry value
- * @return entry with the key and value
+ * @param key map entry key.
+ * @param value map entry value.
+ * @param <K> key type.
+ * @param <V> value type.
+ * @return entry with the key and value.
*/
public static <K, V> AbstractMap.SimpleEntry<K, V> asEntry( K key, V value )
{
@@ -103,7 +105,9 @@
/**
* Constructs a Map from Entries, each containing a (key, value) pair.
*
- * @param entries any number of (key, value) pairs
+ * @param entries any number of (key, value) pairs.
+ * @param <K> key type.
+ * @param <V> value type.
* @return Map of the entries
*/
@SafeVarargs
@@ -125,6 +129,8 @@
*
* @param collection the Collection.
* @param keyMethod the name of the method to obtain the key.
+ * @param <K> key type.
+ * @param <T> value type.
* @return Map of the elements.
*/
@SuppressWarnings( "unchecked" )
@@ -174,6 +180,8 @@
*
* @param list the List.
* @param valueMethod the name of the method to obtain the value.
+ * @param <K> key type.
+ * @param <T> value type.
* @return an ordered List of the obtained values.
*/
@SuppressWarnings( "unchecked" )
=== 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-10-01 13:14:27 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/collection/ListUtils.java 2015-10-01 13:57:42 +0000
@@ -51,6 +51,7 @@
* Removes from the given list the elements at the given indexes. Ignores
* indexes which are out of bounds of list.
*
+ * @param <T> type.
* @param list the list to remove elements from.
* @param indexes the indexes for the elements to remove.
*/
@@ -78,6 +79,7 @@
* Removes from the given list the elements at the given indexes. Ignores
* indexes which are out of bounds of list.
*
+ * @param <T> type.
* @param list the list to operate on.
* @param indexes the list to remove elements from.
*/
@@ -91,8 +93,10 @@
/**
* Returns a sublist of the given list with the elements at the given indexes.
*
+ * @param <T> type.
* @param list the list to select from.
* @param indexes the indexes of the elements in the list to select.
+ * @return sublist of the given list with the elements at the given indexes.
*/
public static <T> List<T> getAtIndexes( List<T> list, List<Integer> indexes )
{
@@ -110,6 +114,7 @@
* Checks whether the given list contains duplicates. List entries are compared
* using the given comparator.
*
+ * @param <T> type.
* @param list the list.
* @param comparator the comparator.
* @return true if the list contains duplicates, false if not.
@@ -137,6 +142,7 @@
* Returns the duplicates in the given list. List entries are compared
* using the given comparator.
*
+ * @param <T> type.
* @param list the list.
* @param comparator the comparator.
* @return a set of duplicates from the given list.
@@ -165,6 +171,7 @@
/**
* Returns the duplicates in the given list.
*
+ * @param <T> type.
* @param list the list.
* @return a set of duplicates from the given list.
*/
@@ -209,9 +216,11 @@
* Returns the sub list of the given list avoiding exceptions, starting on
* the given start index and returning at maximum the given max number of items.
*
+ * @param <T> type.
* @param list the list.
* @param start the start index.
* @param max the max number of items to return.
+ * @return sublist of the given list with the elements at the given indexes.
*/
public static <T> List<T> subList( List<T> list, int start, int max )
{
@@ -228,6 +237,7 @@
/**
* Unions the given array of lists into a single list.
*
+ * @param <T> type.
* @param lists the array of lists.
* @return a union of the given lists.
*/
@@ -308,6 +318,7 @@
/**
* Creates a copy of and sorts the given list.
*
+ * @param <T> type.
* @param list the list to sort.
* @param comparator the comparator to use when sorting.
* @return a sorted list.
=== 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-06-16 17:57:23 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/filter/Filter.java 2015-10-01 13:57:42 +0000
@@ -39,6 +39,7 @@
* Indicates whether the given object to should be retained in the list.
*
* @param object the object.
+ * @return true if object should be retained.
*/
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-07-04 13:26:05 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/filter/FilterUtils.java 2015-10-01 13:57:42 +0000
@@ -41,6 +41,7 @@
/**
* Filters the given collection using the given {@link Filter}.
*
+ * @param <T> type.
* @param collection the {@link Collection}.
* @param filter the filter.
* @param <V> the type of the collection members.
@@ -70,6 +71,7 @@
* Filters the given collection using the given {@link Filter} retaining only
* items which does NOT pass the filter evaluation.
*
+ * @param <T> type.
* @param collection the {@link Collection}.
* @param filter the filter.
* @param <V> the type of the collection members.
=== modified file 'dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/functional/Predicate.java'
--- dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/functional/Predicate.java 2015-07-03 20:29:42 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/functional/Predicate.java 2015-10-01 13:57:42 +0000
@@ -31,7 +31,7 @@
/**
* Predicate on T.
*
- * @author Morten Olav Hansen <mortenoh@xxxxxxxxx>
+ * @author Morten Olav Hansen
*/
public interface Predicate<T>
{
=== 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-09-25 12:41:17 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/timer/SystemTimer.java 2015-10-01 13:57:42 +0000
@@ -33,7 +33,7 @@
/**
* Timer implementation which uses system time.
*
- * @author Morten Olav Hansen <mortenoh@xxxxxxxxx>
+ * @author Morten Olav Hansen
*/
public class SystemTimer
implements Timer
=== 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-06-16 17:57:23 +0000
+++ dhis-2/dhis-support/dhis-support-commons/src/main/java/org/hisp/dhis/commons/timer/Timer.java 2015-10-01 13:57:42 +0000
@@ -31,7 +31,7 @@
/**
* Simple interface that captures time durations and pretty prints it back to you.
*
- * @author Morten Olav Hansen <mortenoh@xxxxxxxxx>
+ * @author Morten Olav Hansen
*/
public interface Timer
{
=== modified file 'dhis-2/pom.xml'
--- dhis-2/pom.xml 2015-09-30 04:46:20 +0000
+++ dhis-2/pom.xml 2015-10-01 13:57:42 +0000
@@ -197,7 +197,21 @@
<encoding>${project.build.sourceEncoding}</encoding>
</configuration>
</plugin>
-
+
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.10.3</version>
+ <executions>
+ <execution>
+ <id>attach-javadocs</id>
+ <goals>
+ <goal>jar</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>findbugs-maven-plugin</artifactId>
