Merge pull request #202 from xjusko/reviews-and-fix-javadoc-error-and…

…-typos

[SHRINKRES-340] fix typos, grammar, errors and add missing descriptions in javadoc

api/src/main/java/org/jboss/shrinkwrap/resolver/api/ConfigurableResolverSystem.java

@@ -75,7 +75,7 @@ CONFIGUREDRESOLVERSYSTEMTYPE fromClassloaderResource(String path) throws Illegal
      * @param loader The classloader
      * @return This configured {@link ResolverSystem}
      * @throws IllegalArgumentException
-     *             If the either argument is not specified or if the path can not be found
+     *             If either argument is not specified or if the path can not be found
      * @throws InvalidConfigurationFileException
      *             If the file is not in correct format
      */

api/src/main/java/org/jboss/shrinkwrap/resolver/api/Invokable.java

@@ -56,7 +56,7 @@ class Invokable {
      *
      * @param cl classloader to be used
      * @param classTypeName fully qualified class name
-     * @return
+     * @return the loaded {@code Class} object
      * @throws InvocationException if class was not found in classloader
      */
     static Class<?> loadClass(ClassLoader cl, String classTypeName) throws InvocationException {
@@ -72,7 +72,7 @@ static Class<?> loadClass(ClassLoader cl, String classTypeName) throws Invocatio
      *
      * @param cl classloader to be used
      * @param classType class object
-     * @return
+     * @return the loaded {@code Class} object
      * @throws InvocationException if class was not found in classloader
      */
     static Class<?> reloadClass(ClassLoader cl, Class<?> classType) throws InvocationException {
@@ -91,7 +91,7 @@ static Class<?> reloadClass(ClassLoader cl, Class<?> classType) throws Invocatio
      * @param parameterTypes parameter types of the method
      * @param instance instance on which method is called, {@code null} for static methods
      * @param parameters parameters for method invocation
-     * @return
+     * @return the result of the method invocation
      * @throws InvocationException if method was not found or could not be invoked
      */
     Object invokeMethod(String name, Class<?>[] parameterTypes, Object instance, Object[] parameters)

api/src/main/java/org/jboss/shrinkwrap/resolver/api/ResolutionFilter.java

@@ -18,7 +18,7 @@
 
 /**
  * Contract for an exclusion-based filter applied during resolution of a {@link Coordinate}. Applies a selective
- * passthrough mechanism. May be chained alongside other {@link ResolutionFilter}s to comprise a
+ * pass through mechanism. May be chained alongside other {@link ResolutionFilter}s to comprise a
  * {@link ResolutionStrategy}.
  *
  * @author <a href="mailto:alr@jboss.org">Andrew Lee Rubinger</a>

api/src/main/java/org/jboss/shrinkwrap/resolver/api/ResolutionStrategy.java

@@ -18,7 +18,7 @@
 
 /**
  * Encapsulates rules defining the logic of resolution (for instance transitivity, exclusions, conditional selection,
- * etc). Subtypes are expected to define the contract specifying exactly what form this may take; this type is provided
+ * etc.). Subtypes are expected to define the contract specifying exactly what form this may take; this type is provided
  * as a base for type safety (ie marker interface).
  *
  * @author <a href="mailto:alr@jboss.org">Andrew Lee Rubinger</a>

api/src/main/java/org/jboss/shrinkwrap/resolver/api/ResolveStage.java

@@ -78,7 +78,7 @@ STRATEGYSTAGETYPE resolve(String... canonicalForms) throws IllegalArgumentExcept
      * next {@link StrategyStage} for the user to define the {@link ResolutionStrategy}. Previously-added dependencies
      * will be included in resolution.
      *
-     * @param canonicalForms  A {@link Collection} of the canonical forms a of the desired dependencies.
+     * @param canonicalForms  A {@link Collection} of the canonical forms of the desired dependencies.
      * @return The next {@link StrategyStage} for the user to define the {@link ResolutionStrategy}.
      * @throws IllegalArgumentException
      * If no coordinates are supplied

api/src/main/java/org/jboss/shrinkwrap/resolver/api/ResolveWithRangeSupportStage.java

@@ -41,7 +41,7 @@ public interface ResolveWithRangeSupportStage<
      *
      * @param coordinate coordinate in canonical form containing version range:
      *                   <a href="http://maven.apache.org/enforcer/enforcer-rules/versionRanges.html">Maven doc</a>}
-     * @return A info about available versions.StrategyStage
+     * @return Info about available versions.StrategyStage
      * @throws IllegalArgumentException If no coordinate is supplied
      */
     VERSIONRANGERESULTTYPE resolveVersionRange(String coordinate) throws IllegalArgumentException;

api/src/main/java/org/jboss/shrinkwrap/resolver/api/ResolvedArtifact.java

@@ -29,7 +29,7 @@
 public interface ResolvedArtifact<RESOLVEDTYPE extends ResolvedArtifact<RESOLVEDTYPE>> {
 
     /**
-     * Returns resolved artifact, optionally casted to the sub type of {@link ResolvedArtifact}
+     * Returns resolved artifact, optionally cast to the subtype of {@link ResolvedArtifact}
      *
      * @return The resolved artifact.
      */
@@ -43,16 +43,16 @@ public interface ResolvedArtifact<RESOLVEDTYPE extends ResolvedArtifact<RESOLVED
     File asFile();
 
     /**
-     * Returns resolved artifact as an @{link {@link InputStream}. It is a responsibility of the caller to close stream
+     * Returns resolved artifact as an {@link InputStream}. It is a responsibility of the caller to close stream
      * afterwards.
      *
-     * @return The resolved artifact as an @{link {@link InputStream}.
+     * @return The resolved artifact as an {@link InputStream}.
      */
     InputStream asInputStream();
 
     /**
      * Returns resolved artifact formatted to {@code returnTypeClass}.
-     *
+     * <p>
      * See {@code FormatProcessor} to register additional format.
      *
      * @param <RETURNTYPE> The return type

api/src/main/java/org/jboss/shrinkwrap/resolver/api/ResolverSystemFactory.java

@@ -40,8 +40,8 @@ private ResolverSystemFactory() {
     /**
      * Creates a new {@link ResolverSystem} instance of the specified user view type using the {@link Thread} Context
      * {@link ClassLoader}. Will consult a configuration file visible to the {@link Thread} Context {@link ClassLoader} named
-     * "META-INF/services/$fullyQualfiedClassName" which should contain a key=value format with the key
-     * {@link ResolverSystemFactory#KEY_IMPL_CLASS_NAME}. The implementation class name must have a no-arg constructor.
+     * "META-INF/services/$fullyQualifiedClassName" which should contain a key=value format with a key representing the fully
+     * qualified class name of the implementation class. The implementation class name must have a no-arg constructor.
      *
      * @param userViewClass The user view type
      * @return The new {@link ResolverSystem} instance of the specified user view type created by using the {@link Thread}
@@ -55,11 +55,10 @@ static <RESOLVERSYSTEMTYPE extends ResolverSystem> RESOLVERSYSTEMTYPE createFrom
     }
 
     /**
-     * Creates a new {@link ResolverSystem} instance of the specified user view type using the specified {@link ClassLoader}.
-     * Will consult a configuration file visible to the specified {@link ClassLoader} named
-     * "META-INF/services/$fullyQualfiedClassName" which should contain a key=value format with the key
-     * {@link ResolverSystemFactory#KEY_IMPL_CLASS_NAME}. The implementation class name must have a no-arg constructor.
-     *
+     * Creates a new {@link ResolverSystem} instance of the specified user view type using the {@link Thread} Context
+     * {@link ClassLoader}. Will consult a configuration file visible to the {@link Thread} Context {@link ClassLoader} named
+     * "META-INF/services/$fullyQualifiedClassName" which should contain a key=value format with a key representing the fully
+     * qualified class name of the implementation class. The implementation class name must have a no-arg constructor.
      *
      * @param userViewClass The user view type
      * @param cl The {@link ClassLoader}

gradle/api-gradle-embedded-archive/src/main/java/org/jboss/shrinkwrap/api/gradle/archive/importer/embedded/ConfigurationStage.java

@@ -27,15 +27,15 @@ public interface ConfigurationStage extends BuildStage {
     ConfigurationStage useGradleUserHomeDir(File gradleUserHomeDir);
 
     /**
-     * Set tasks which will be executed during build. By default: [build].
+     * Set tasks which will be executed during build. Default: [build].
      *
      * @param tasks
      *            List of tasks to be executed.
      */
     ConfigurationStage forTasks(String... tasks);
 
     /**
-     * Sets argument which will be used during build. By default: "--exclude-task test".
+     * Sets argument which will be used during build. Default: "--exclude-task test".
      *
      * @param arguments
      *            Arguments to be used

maven/api-maven-archive/src/main/java/org/jboss/shrinkwrap/resolver/api/maven/archive/importer/MavenImporter.java

@@ -64,7 +64,7 @@ ConfiguredMavenImporter configureFromFile(String pathToFile) throws IllegalArgum
      *
      * @param path A {@link ClassLoader} path to a settings.xml file this {@link MavenImporter} should be configured from.
      * @return This configured {@link MavenImporter}
-     * @throws IllegalArgumentException If the either argument is not specified or if the path can not be found
+     * @throws IllegalArgumentException If any of the arguments is not specified or if the path can not be found
      * @throws UnsupportedOperationException If this {@link ConfigurableResolverSystem} does not support configuration by
      *         {@link ClassLoader} resource
      * @throws InvalidConfigurationFileException If the configuration file contents are not in appropriate format
@@ -79,7 +79,7 @@ ConfiguredMavenImporter configureFromClassloaderResource(String path) throws Ill
      * @param path A {@link ClassLoader} path to a settings.xml file this {@link MavenImporter} should be configured from.
      * @param cl A {@link ClassLoader}
      * @return This configured {@link MavenImporter}
-     * @throws IllegalArgumentException If the either argument is not specified or if the path can not be found
+     * @throws IllegalArgumentException If any of the arguments is not specified or if the path can not be found
      * @throws UnsupportedOperationException If this {@link ConfigurableResolverSystem} does not support configuration by
      *         {@link ClassLoader} resource
      * @throws InvalidConfigurationFileException If the configuration file contents are not in appropriate format

maven/api-maven-archive/src/main/java/org/jboss/shrinkwrap/resolver/api/maven/archive/importer/PomlessMavenImporter.java

@@ -81,7 +81,7 @@ PomEquippedMavenImporter loadPomFromFile(String pathToPomFile, String... profile
      * Configures the Maven Importer from Project Object Model contained in the POM file located at the specified
      * {@link ClassLoader} resource path, loaded by the current {@link Thread#getContextClassLoader()}.
      *
-     * @param pathToPomResource A {@link ClassLoader} resource path to a POM filee the maven Importer should be configured from.
+     * @param pathToPomResource A {@link ClassLoader} resource path to a POM file the maven Importer should be configured from.
      * @return The configured Maven Importer from the given Project Object Model.
      * @throws IllegalArgumentException If no path was specified, or if the resource could not be found at the specified path
      * @throws InvalidConfigurationFileException If the configuration file contents are not in appropriate format
@@ -93,7 +93,7 @@ PomEquippedMavenImporter loadPomFromClassLoaderResource(String pathToPomResource
      * Configures the Maven Importer from Project Object Model contained in the POM file located at the specified
      * {@link ClassLoader} resource path, loaded by the specified {@link ClassLoader}.
      *
-     * @param pathToPomResource A {@link ClassLoader} resource path to a POM filee the maven Importer should be configured from.
+     * @param pathToPomResource A {@link ClassLoader} resource path to a POM file the maven Importer should be configured from.
      * @param cl A {@link ClassLoader}
      * @return The configured Maven Importer from the given Project Object Model.
      * @throws IllegalArgumentException If no path was specified, no ClassLoader was specified, or if the resource could not be
@@ -107,7 +107,7 @@ PomEquippedMavenImporter loadPomFromClassLoaderResource(String pathToPomResource
      * Configures the Maven Importer from Project Object Model contained in the POM file located at the specified
      * {@link ClassLoader} resource path, loaded by the specified {@link ClassLoader}.
      *
-     * @param pathToPomResource A {@link ClassLoader} resource path to a POM filee the maven Importer should be configured from.
+     * @param pathToPomResource A {@link ClassLoader} resource path to a POM file the maven Importer should be configured from.
      * @param cl A {@link ClassLoader}
      * @param profiles Active/inactive profiles
      * @return The configured Maven Importer from the given Project Object Model.
@@ -119,7 +119,7 @@ PomEquippedMavenImporter loadPomFromClassLoaderResource(String pathToPomResource
             throws IllegalArgumentException, InvalidConfigurationFileException;
 
     /**
-     * <i>Optional operation</i>. Sets whether resolution should be done in "offline" (ie. not connected to Internet) mode.
+     * <i>Optional operation</i>. Sets whether resolution should be done in "offline" (i.e. not connected to Internet) mode.
      * By default, resolution is done in online mode
      *
      * @param offline Whether resolution should be done in "offline". By default, resolution is done in online mode.
@@ -129,7 +129,7 @@ PomEquippedMavenImporter loadPomFromClassLoaderResource(String pathToPomResource
     PomlessMavenImporter offline(boolean offline);
 
     /**
-     * <i>Optional operation</i>. Sets that resolution should be done in "offline" (ie. not connected to Internet) mode. Alias to
+     * <i>Optional operation</i>. Sets that resolution should be done in "offline" (i.e. not connected to Internet) mode. Alias to
      * {@link ConfiguredMavenImporter#offline(boolean)}, passing <code>true</code> as a parameter.
      *
      * @return Modified {@link PomlessMavenImporter} instance

maven/api-maven-embedded/src/main/java/org/jboss/shrinkwrap/resolver/api/maven/embedded/DistributionStage.java

@@ -58,7 +58,7 @@ public interface DistributionStage<NEXT_STEP extends BuildStage<DAEMON_TRIGGER_T
     NEXT_STEP useInstallation(File mavenHome);
 
     /**
-     * Use default Maven distribution with version {@link DEFAULT_MAVEN_VERSION}.
+     * Use default Maven distribution with version {@value DEFAULT_MAVEN_VERSION}.
      *
      * @return Modified EmbeddedMaven instance
      */

maven/api-maven-embedded/src/main/java/org/jboss/shrinkwrap/resolver/api/maven/embedded/daemon/WithTimeoutDaemonBuilder.java

@@ -12,7 +12,7 @@ public interface WithTimeoutDaemonBuilder extends DaemonBuildTriggerWithoutTimeo
      * @param regex Regex a line of the build output should match
      * @return An instance of {@link DaemonBuildTriggerWithTimeout}
      */
-    DaemonBuildTriggerWithTimeout withWaitUntilOutputLineMathes(String regex);
+    DaemonBuildTriggerWithTimeout withWaitUntilOutputLineMatches(String regex);
 
     /**
      * Resolver will wait until the specified regex matches some line of the build output.
@@ -23,5 +23,5 @@ public interface WithTimeoutDaemonBuilder extends DaemonBuildTriggerWithoutTimeo
      * @param timeoutUnit the time unit of the {@code timeout} argument
      * @return An instance of {@link DaemonBuildTriggerWithTimeout}
      */
-    DaemonBuildTriggerWithTimeout withWaitUntilOutputLineMathes(String regex, long timeout, TimeUnit timeoutUnit);
+    DaemonBuildTriggerWithTimeout withWaitUntilOutputLineMatches(String regex, long timeout, TimeUnit timeoutUnit);
 }

maven/api-maven-embedded/src/main/java/org/jboss/shrinkwrap/resolver/api/maven/embedded/pom/equipped/ConfigurationStage.java

@@ -79,7 +79,7 @@ public interface ConfigurationStage<DIST_OR_CONFIG extends ConfigurationStage<Co
       * Sets the failure mode of the Maven invocation. Equivalent of {@code -ff} and {@code --fail-fast}, {@code -fae}
       * and {@code --fail-at-end}, {@code -fn} and {@code --fail-never}
       *
-      * @param failureBehavior The failure mode, must be one of {@link InvocationRequest.ReactorFailureBehavior#FailFast},
+      * @param reactorFailureBehavior The failure mode, must be one of {@link InvocationRequest.ReactorFailureBehavior#FailFast},
       *            {@link InvocationRequest.ReactorFailureBehavior#FailAtEnd} and {@link InvocationRequest.ReactorFailureBehavior#FailNever}.
       * @return Modified instance of EmbeddedMaven
       */
@@ -259,7 +259,7 @@ public interface ConfigurationStage<DIST_OR_CONFIG extends ConfigurationStage<Co
      /**
       * Sets the recursion behavior of a reactor invocation. Inverse equivalent of -N and --non-recursive
       *
-      * @param recursive true if sub modules should be build, false otherwise.
+      * @param recursive true if submodules should be built, false otherwise.
       * @return Modified instance of EmbeddedMaven
       */
      DIST_OR_CONFIG setRecursive(boolean recursive);
@@ -292,7 +292,7 @@ public interface ConfigurationStage<DIST_OR_CONFIG extends ConfigurationStage<Co
      /**
       * Thread count, for instance 2.0C where C is core multiplied Equivalent of -T or --threads
       *
-      * @param threads the threadcount
+      * @param threads the thread count
       * @return Modified instance of EmbeddedMaven
       */
      DIST_OR_CONFIG setThreads(String threads);
@@ -338,7 +338,7 @@ public interface ConfigurationStage<DIST_OR_CONFIG extends ConfigurationStage<Co
      DIST_OR_CONFIG setResumeFrom(String resumeFrom);
 
      /**
-      * Sets if the build output shold be in the quiet mode or not.
+      * Sets if the build output should be in the quiet mode or not.
       * It means that the output will not be printed on standard output, but it will be accessible via the
       * {@link BuiltProject#getMavenLog()}. Default is false
       *

maven/api-maven/src/main/java/org/jboss/shrinkwrap/resolver/api/maven/ConfigurableMavenResolverSystemBase.java

@@ -61,7 +61,7 @@ public interface ConfigurableMavenResolverSystemBase<UNCONFIGURABLERESOLVERSYSTE
      *
      * @param name a unique arbitrary ID such as "codehaus"
      * @param url the repository URL, such as "http://snapshots.maven.codehaus.org/maven2"
-     * @param layout the repository layout. Should always be "default" (may be reused one day by Maven with other values).
+     * @param layout the repository layout. Should always be "default" (maybe reused one day by Maven with other values).
      * @return Modified instance of {@code PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE}
      * @throws IllegalArgumentException if name or layout are null or if layout is not "default", or if no url protocol is
      * specified, or an unknown url protocol is found, or url is null
@@ -73,7 +73,7 @@ public interface ConfigurableMavenResolverSystemBase<UNCONFIGURABLERESOLVERSYSTE
      *
      * @param name a unique arbitrary ID such as "codehaus"
      * @param url the repository URL, such as "http://snapshots.maven.codehaus.org/maven2"
-     * @param layout the repository layout. Should always be "default" (may be reused one day by Maven with other values).
+     * @param layout the repository layout. Should always be "default" (maybe reused one day by Maven with other values).
      * @return Modified instance of {@code PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE}
      */
     PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE withRemoteRepo(String name, URL url, String layout);
@@ -115,8 +115,8 @@ public interface ConfigurableMavenResolverSystemBase<UNCONFIGURABLERESOLVERSYSTE
      * Sets whether to consult artifact metadata in local repository and track origin of artifacts there;
      * ignores origin of artifacts in local repository. Note that offline repository has the same behavior.
      *
-     * @param useLegacyLocalReposity Whether to ignore origin of artifacts in local repository; defaults to false
+     * @param useLegacyLocalRepository Whether to ignore origin of artifacts in local repository; defaults to false
      * @return Modified instance of {@code PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE}
      */
-    PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE useLegacyLocalRepo(boolean useLegacyLocalReposity);
+    PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE useLegacyLocalRepo(boolean useLegacyLocalRepository);
 }