Spell checking, javadoc and formatting

git-svn-id: https://svn.apache.org/repos/asf/ant/ivy/core/trunk@780753 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/ivy/core/module/descriptor/DefaultDependencyDescriptor.java

@@ -123,7 +123,7 @@ public class DefaultDependencyDescriptor implements DependencyDescriptor {
 
     private ModuleRevisionId dynamicRevId;
 
-    private Map confs = new LinkedHashMap();
+    private Map/*<String,List<String>>*/ confs = new LinkedHashMap();
 
     // Map (String masterConf -> Collection(DependencyArtifactDescriptor))
     private Map dependencyArtifacts; // initialized on demand only for memory consumption reason

src/java/org/apache/ivy/core/module/descriptor/MDArtifact.java

@@ -43,7 +43,7 @@ public class MDArtifact extends AbstractArtifact {
 
     private String ext;
 
-    private List confs = new ArrayList();
+    private List/*<String>*/ confs = new ArrayList();
 
     private Map extraAttributes = null;
 

src/java/org/apache/ivy/core/report/ConfigurationResolveReport.java

@@ -56,13 +56,13 @@ public class ConfigurationResolveReport {
 
     private final ResolveOptions options;
 
-    private Map dependencyReports = new LinkedHashMap();
+    private Map/*<IvyNode, List<ArtifactDownloadReport>>*/ dependencyReports = new LinkedHashMap();
 
-    private Map dependencies = new LinkedHashMap();
+    private Map/*<ModuleRevisionId, IvyNode>*/ dependencies = new LinkedHashMap();
 
     private final ResolveEngine resolveEngine;
 
-    private Map modulesIdsMap = new LinkedHashMap();
+    private Map/*<ModuleId, Collection<IvyNode>>*/ modulesIdsMap = new LinkedHashMap();
 
     private List modulesIds;
 

src/java/org/apache/ivy/core/report/ResolveReport.java

@@ -50,9 +50,9 @@ public class ResolveReport {
     /**
      * the list of all dependencies resolved, ordered from the more dependent to the less dependent
      */
-    private List dependencies = new ArrayList();
+    private List/*<IvyNode>*/ dependencies = new ArrayList();
 
-    private List artifacts = new ArrayList();
+    private List/*<Artifact>*/ artifacts = new ArrayList();
 
     private long resolveTime;
 

src/java/org/apache/ivy/plugins/namespace/Namespace.java

@@ -29,7 +29,7 @@ public class Namespace {
         SYSTEM_NAMESPACE = new Namespace();
     }
 
-    private List rules = new ArrayList();
+    private List/*<NamespaceRule>*/ rules = new ArrayList();
 
     private String name;
 

src/java/org/apache/ivy/plugins/repository/Repository.java

@@ -32,7 +32,7 @@ import org.apache.ivy.core.module.descriptor.Artifact;
  * A repository supports the following fundamental operations
  * <ul>
  * <li>retrieving a resource from the repository.</li>
- * <li>transfering a resource to the repository.</li>
+ * <li>transferring a resource to the repository.</li>
  * <li>retrieving a listing of resources.</li>
  * </ul>
  * </p>
@@ -66,7 +66,7 @@ public interface Repository {
      *            A string identifying the resource.
      * @return The resource associated with the resource identifier.
      * @throws IOException
-     *             On error whle trying to get resource.
+     *             On error while trying to get resource.
      */
     Resource getResource(String source) throws IOException;
 
@@ -130,7 +130,7 @@ public interface Repository {
      * Determine if a given listener is attached to the repository.
      * 
      * @param listener
-     *            The listener being quireied
+     *            The listener being queried
      * @return <code>true</code> if the provided listener is attached to the repository,
      *         <code>false</code> if not.
      */

src/java/org/apache/ivy/plugins/repository/sftp/SFTPRepository.java

@@ -78,12 +78,12 @@ public class SFTPRepository extends AbstractSshBasedRepository {
     }
 
     /**
-     * This method is similar to getResource, except that the returned resource is fully initialised
+     * This method is similar to getResource, except that the returned resource is fully initialized
      * (resolved in the sftp repository), and that the given string is a full remote path
      * 
      * @param path
      *            the full remote path in the repository of the resource
-     * @return a fully initialised resource, able to answer to all its methods without needing any
+     * @return a fully initialized resource, able to answer to all its methods without needing any
      *         further connection
      */
     public Resource resolveResource(String path) {

src/java/org/apache/ivy/plugins/resolver/AbstractResolver.java

@@ -69,7 +69,7 @@ public abstract class AbstractResolver
 
     /**
      * True if parsed ivy files should be validated against xsd, false if they should not, null if
-     * default behaviur should be used
+     * default behavior should be used
      */
     private Boolean validate = null;
 

src/java/org/apache/ivy/plugins/resolver/DependencyResolver.java

@@ -167,7 +167,16 @@ public interface DependencyResolver {
      * </p>
      */
     String[] listTokenValues(String token, Map otherTokenValues);
-    
+
+    /**
+     * Same as {@link #listTokenValues(String, Map)} but more generic.
+     * 
+     * @param tokens
+     *            the tokens of the query
+     * @param criteria
+     *            the token which have values
+     * @return the list of token values (Map<Strin, String>[]), must not be <code>null</code>
+     */
     Map[] listTokenValues(String[] tokens, Map criteria);
 
     OrganisationEntry[] listOrganisations();

src/java/org/apache/ivy/plugins/resolver/RepositoryResolver.java

@@ -220,7 +220,8 @@ public class RepositoryResolver extends AbstractPatternsBasedResolver {
         String[] checksums = getChecksumAlgorithms();
         for (int i = 0; i < checksums.length; i++) {
             if (!ChecksumHelper.isKnownAlgorithm(checksums[i])) {
-                throw new IllegalArgumentException("Unknown checksum algorithm: " + checksums[i]);            }
+                throw new IllegalArgumentException("Unknown checksum algorithm: " + checksums[i]);
+            }
         }
         
         repository.put(artifact, src, dest, overwrite);

src/java/org/apache/ivy/plugins/resolver/util/ResolverHelper.java

@@ -75,7 +75,7 @@ public final class ResolverHelper {
                     namePattern = namePattern.replaceAll("\\.", "\\\\.");
                     String acceptNamePattern = ".*?"
                             + IvyPatternHelper.substituteToken(namePattern, token, "([^" + fileSep
-                                    + "]+)") + "($|" + fileSep + ".*)" ;
+                                    + "]+)") + "($|" + fileSep + ".*)";
                     Pattern p = Pattern.compile(acceptNamePattern);
                     for (Iterator iter = all.iterator(); iter.hasNext();) {
                         String path = (String) iter.next();

src/java/org/apache/ivy/plugins/version/VersionMatcher.java

@@ -25,15 +25,21 @@ import org.apache.ivy.core.module.id.ModuleRevisionId;
 /**
  * This interface defines a version matcher, i.e. a class able to tell if the revision asked by a
  * module for a dependency is dynamic (i.e. need to find all revisions to find the good one among
- * them) and if a found revision matches the asked one. Two ways of matching are possible: - based
- * on the module revision only (known as ModuleRevisionId) - based on the parsed module descriptor
+ * them) and if a found revision matches the asked one.
+ * <p>
+ * Two ways of matching are possible:
+ * <ul>
+ * <li>based on the module revision only (known as ModuleRevisionId)</li>
+ * <li>based on the parsed module descriptor</li>
+ * </ul>
  * The second being much more time consuming than the first, the version matcher should tell if it
- * needs such parsing or not using the needModuleDescriptor(ModuleRevisionId askedMrid,
- * ModuleRevisionId foundMrid) method. Anyway, the first way is always used, and if a revision is
- * not accepted using the first method, the module descriptor won't be parsed. Therefore if a
- * version matcher uses only module descriptors to accept a revision or not it should always return
- * true to needModuleDescriptor(ModuleRevisionId askedMrid, ModuleRevisionId foundMrid) and
- * accept(ModuleRevisionId askedMrid, ModuleRevisionId foundMrid).
+ * needs such parsing or not using the
+ * {@link #needModuleDescriptor(ModuleRevisionId, ModuleRevisionId)} method. Anyway, the first way
+ * is always used, and if a revision is not accepted using the first method, the module descriptor
+ * won't be parsed. Therefore if a version matcher uses only module descriptors to accept a revision
+ * or not it should always return true to
+ * {@link #needModuleDescriptor(ModuleRevisionId, ModuleRevisionId)} and
+ * {@link #accept(ModuleRevisionId, ModuleDescriptor)}.
  */
 public interface VersionMatcher {
     /**