svn commit: r1617638 - /logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/SetUtils.java

[ma...@apache.org]

Author: mattsicker
Date: Wed Aug 13 00:33:47 2014
New Revision: 1617638

URL: http://svn.apache.org/r1617638
Log:
Add javadoc for SetUtils.

Modified:
    logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/SetUtils.java

Modified: logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/SetUtils.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/SetUtils.java?rev=1617638&r1=1617637&r2=1617638&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/SetUtils.java (original)
+++ logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/SetUtils.java Wed Aug 13 00:33:47 2014
@@ -27,6 +27,13 @@ import java.util.Set;
 public final class SetUtils {
     private SetUtils() {}
 
+    /**
+     * Extracts the Strings from a Set that start with a given prefix.
+     *
+     * @param set    a Set of Strings (assumed to all be non-{@code null})
+     * @param prefix the prefix to look for in the string set
+     * @return an array of the matching strings from the given set
+     */
     public static String[] prefixSet(final Set<String> set, final String prefix) {
         final Set<String> prefixSet = new HashSet<String>();
         for (final String str : set) {