Index: /home/tverhagen/dev_ext/ivy/src/java/org/apache/ivy/util/ConfigurationUtils.java
===================================================================
--- /home/tverhagen/dev_ext/ivy/src/java/org/apache/ivy/util/ConfigurationUtils.java (revision 552422)
+++ /home/tverhagen/dev_ext/ivy/src/java/org/apache/ivy/util/ConfigurationUtils.java (working copy)
@@ -37,11 +37,14 @@
}
/**
- * Replace all the wildcards in the given configuration array. Supported wildcards are:
+ * Replace the wildcards in the given configuration array, by the name of the given
+ * ModuleDescriptor
+ *
+ * The supported wildcards are:
*
- * - *:all configurations
- * - *(public):all public configurations
- * - *(private):all private configurations
+ * - * : all configurations
+ * - *(public) : all public configurations
+ * - *(private) : all private configurations
*
* If the given array of configurations is null, all configurations are returned.
*
@@ -52,8 +55,8 @@
* @return
*/
public static String[] replaceWildcards(String[] confs, ModuleDescriptor md) {
- Set result = new LinkedHashSet();
-
+ // TODO [2007.06.28] Is it correct to return no configurations, if the incomming
+ // confs is just an empty array?
if (confs == null) {
return md.getConfigurationsNames();
}
@@ -58,6 +61,7 @@
return md.getConfigurationsNames();
}
+ Set result = new LinkedHashSet();
for (int i = 0; i < confs.length; i++) {
if ("*".equals(confs[i])) {
result.addAll(Arrays.asList(md.getConfigurationsNames()));
Index: /home/tverhagen/dev_ext/ivy/src/java/org/apache/ivy/util/extendable/ExtendableItem.java
===================================================================
--- /home/tverhagen/dev_ext/ivy/src/java/org/apache/ivy/util/extendable/ExtendableItem.java (revision 552422)
+++ /home/tverhagen/dev_ext/ivy/src/java/org/apache/ivy/util/extendable/ExtendableItem.java (working copy)
@@ -55,7 +55,7 @@
* The Map keys are attribute names as Strings, and values are corresponding attribute values
* (as String too)
*
- * @return
+ * @return A Map instance containing all the attributes and their values.
*/
Map getAttributes();
@@ -63,7 +63,7 @@
* Returns a Map of all standard attributes of this extendable item. The Map keys are attribute
* names as Strings, and values are corresponding attribute values (as String too)
*
- * @return
+ * @return A Map instance containing all the standard attributes and their values.
*/
Map getStandardAttributes();
@@ -71,7 +71,7 @@
* Returns a Map of all extra attributes of this extendable item. The Map keys are attribute
* names as Strings, and values are corresponding attribute values (as String too)
*
- * @return
+ * @return A Map instance containing all the extra attributes and their values.
*/
Map getExtraAttributes();
}
Index: /home/tverhagen/dev_ext/ivy/src/java/org/apache/ivy/util/FileUtil.java
===================================================================
--- /home/tverhagen/dev_ext/ivy/src/java/org/apache/ivy/util/FileUtil.java (revision 552422)
+++ /home/tverhagen/dev_ext/ivy/src/java/org/apache/ivy/util/FileUtil.java (working copy)
@@ -239,8 +239,8 @@
* Returns a collection of all Files being contained in the given directory, recursively,
* including directories.
*
- * @param dir
- * @return
+ * @param dir The directory from which all files, including files in subdirectory) are extracted.
+ * @return A collectoin containing all the files of the given directory and it's subdirectories.
*/
public static Collection listAll(File dir) {
return listAll(dir, new ArrayList());
Index: /home/tverhagen/dev_ext/ivy/src/java/org/apache/ivy/util/filter/FilterHelper.java
===================================================================
--- /home/tverhagen/dev_ext/ivy/src/java/org/apache/ivy/util/filter/FilterHelper.java (revision 552422)
+++ /home/tverhagen/dev_ext/ivy/src/java/org/apache/ivy/util/filter/FilterHelper.java (working copy)
@@ -33,7 +33,8 @@
return NO_FILTER;
}
String[] t = types.split(",");
- List acceptedTypes = new ArrayList(types.length());
+ // TODO [2007.06.28] Check if types.length() shouldn't be t.length().
+ List acceptedTypes = new ArrayList(types.length());
for (int i = 0; i < t.length; i++) {
acceptedTypes.add(t[i].trim());
}
@@ -41,12 +42,16 @@
}
/**
- * we could have used commons-collections facility for this... if we accepted to add
- * dependencies on third party jars
+ * Returns a new collection containing only the items from the given collectoin, which are
+ * accepted by the filter.
*
- * @param col
- * @param filter
- * @return
+ * @param col The collection to filter.
+ * @param filter The filter to use.
+ * @return A new collection instance containing the only the instance accepted by the filter.
+ *
+ *
+ * Comment: We could have used Commons-Collections
+ * facility for this. If we accepted to add dependencies on third party jars.
*/
public static Collection filter(Collection col, Filter filter) {
if (filter == null) {
Index: /home/tverhagen/dev_ext/ivy/src/java/org/apache/ivy/util/StringUtils.java
===================================================================
--- /home/tverhagen/dev_ext/ivy/src/java/org/apache/ivy/util/StringUtils.java (revision 552422)
+++ /home/tverhagen/dev_ext/ivy/src/java/org/apache/ivy/util/StringUtils.java (working copy)
@@ -35,12 +35,16 @@
}
/**
- * Joins the given object array in one string, each separated by the given separator. Example:
+ * Joins the given object array in one string, each separated by the given separator.
+ *
+ * Example:
+ *
* join(new String[] {"one", "two", "three"}, ", ") -> "one, two, three"
+ *
*
- * @param objs
- * @param sep
- * @return
+ * @param objs The array of objects (toString() is used).
+ * @param sep The separator to use.
+ * @return The concatinated string.
*/
public static String join(Object[] objs, String sep) {
StringBuffer buf = new StringBuffer();
@@ -102,7 +106,7 @@
*
* @param str
* the encrypted string to decrypt
- * @return
+ * @return The decrypted string.
*/
public final static String decrypt(String str) {
if (str == null) {
Index: /home/tverhagen/dev_ext/ivy/src/java/org/apache/ivy/util/url/URLHandler.java
===================================================================
--- /home/tverhagen/dev_ext/ivy/src/java/org/apache/ivy/util/url/URLHandler.java (revision 552422)
+++ /home/tverhagen/dev_ext/ivy/src/java/org/apache/ivy/util/url/URLHandler.java (working copy)
@@ -117,10 +117,12 @@
public long getLastModified(URL url, int timeout);
/**
- * never returns null, return UNAVAILABLE when url is not reachable
+ * Returns the URLInfo of the given url or a {@link #UNAVAILABLE} instance,
+ * if the url is not reachable.
*
- * @param url
- * @return
+ * @param url The url from which information is retrieved.
+ * @return The URLInfo extracted from the given url, or {@link #UNAVAILABLE} when
+ * the url is not available.
*/
public URLInfo getURLInfo(URL url);
@@ -127,8 +129,10 @@
/**
* never returns null, return UNAVAILABLE when url is not reachable
*
- * @param url
- * @return
+ * @param url The url from which information is retrieved.
+ * @param timeout The timeout in milliseconds.
+ * @return The URLInfo extracted from the given url, or {@link #UNAVAILABLE} when
+ * the url is not available.
*/
public URLInfo getURLInfo(URL url, int timeout);