[MNG-6176] Javadoc errors prevent release with Java 8

Upgrade modello to 1.9.0
Fix invalid Javadoc
This commit is contained in:
rfscholte 2017-03-10 16:17:28 +01:00
parent 8f025faab8
commit 587317b009
59 changed files with 186 additions and 162 deletions

View File

@ -29,9 +29,11 @@ import java.util.Properties;
import java.util.Stack; import java.util.Stack;
/** /**
* <p>
* Generic implementation of version comparison. * Generic implementation of version comparison.
* </p>
* *
* <p>Features: * Features:
* <ul> * <ul>
* <li>mixing of '<code>-</code>' (hyphen) and '<code>.</code>' (dot) separators,</li> * <li>mixing of '<code>-</code>' (hyphen) and '<code>.</code>' (dot) separators,</li>
* <li>transition between characters and digits also constitutes a separator: * <li>transition between characters and digits also constitutes a separator:
@ -51,7 +53,7 @@ import java.util.Stack;
* Unknown qualifiers are considered after known qualifiers, with lexical order (always case insensitive), * Unknown qualifiers are considered after known qualifiers, with lexical order (always case insensitive),
* </li> * </li>
* <li>a hyphen usually precedes a qualifier, and is always less important than something preceded with a dot.</li> * <li>a hyphen usually precedes a qualifier, and is always less important than something preceded with a dot.</li>
* </ul></p> * </ul>
* *
* @see <a href="https://cwiki.apache.org/confluence/display/MAVENOLD/Versioning">"Versioning" on Maven Wiki</a> * @see <a href="https://cwiki.apache.org/confluence/display/MAVENOLD/Versioning">"Versioning" on Maven Wiki</a>
* @author <a href="mailto:kenney@apache.org">Kenney Westerhof</a> * @author <a href="mailto:kenney@apache.org">Kenney Westerhof</a>

View File

@ -72,9 +72,10 @@ public class VersionRange
} }
/** /**
* <p>
* Create a version range from a string representation * Create a version range from a string representation
* <p/> * </p>
* Some spec examples are * Some spec examples are:
* <ul> * <ul>
* <li><code>1.0</code> Version 1.0</li> * <li><code>1.0</code> Version 1.0</li>
* <li><code>[1.0,2.0)</code> Versions 1.0 (included) to 2.0 (not included)</li> * <li><code>[1.0,2.0)</code> Versions 1.0 (included) to 2.0 (not included)</li>

View File

@ -113,6 +113,18 @@ under the License.
</dependencies> </dependencies>
<build> <build>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<!-- There's no maintenance on maven-compat -->
<additionalparam>-Xdoclint:none</additionalparam>
</configuration>
</plugin>
</plugins>
</pluginManagement>
<plugins> <plugins>
<plugin> <plugin>
<groupId>org.codehaus.plexus</groupId> <groupId>org.codehaus.plexus</groupId>

View File

@ -31,9 +31,14 @@ import org.apache.maven.artifact.versioning.OverConstrainedVersionException;
/** /**
* Specific problems during resolution that we want to account for: * Specific problems during resolution that we want to account for:
* <p/> * <ul>
* - missing metadata - version range violations - version circular dependencies - missing artifacts * <li>missing metadata</li>
* - network/transfer errors - file system errors: permissions * <li>version range violations</li>
* <li>version circular dependencies</li>
* <li>missing artifacts</li>
* <li>network/transfer errors</li>
* <li>file system errors: permissions</li>
* </ul>
* *
* @author Jason van Zyl * @author Jason van Zyl
* TODO carlos: all these possible has*Exceptions and get*Exceptions methods make the clients too * TODO carlos: all these possible has*Exceptions and get*Exceptions methods make the clients too
@ -175,7 +180,7 @@ public class ArtifactResolutionResult
/** /**
* TODO this needs to accept a {@link OverConstrainedVersionException} as returned by * TODO this needs to accept a {@link OverConstrainedVersionException} as returned by
* {@link #getVersionRangeViolation(int)} but it's not used like that in * {@link #getVersionRangeViolation(int)} but it's not used like that in
* {@link DefaultLegacyArtifactCollector} * DefaultLegacyArtifactCollector
*/ */
public ArtifactResolutionResult addVersionRangeViolation( Exception e ) public ArtifactResolutionResult addVersionRangeViolation( Exception e )
{ {

View File

@ -108,7 +108,7 @@ public class ResolutionNode
} }
/** /**
* @return {@link List} &lt; {@link String} > with artifact ids * @return {@link List} &lt; {@link String} &gt; with artifact ids
* @throws OverConstrainedVersionException * @throws OverConstrainedVersionException
*/ */
public List<String> getDependencyTrail() public List<String> getDependencyTrail()

View File

@ -24,13 +24,15 @@ import org.apache.maven.plugin.MojoExecution;
import org.apache.maven.project.MavenProject; import org.apache.maven.project.MavenProject;
/** /**
* <p>
* Encapsulates parameters of MojoExecutionListener callback methods and is meant to provide API evolution path should * Encapsulates parameters of MojoExecutionListener callback methods and is meant to provide API evolution path should
* it become necessary to introduce new parameters in the existing callbacks in the future. * it become necessary to introduce new parameters in the existing callbacks in the future.
* </p>
* <strong>Note:</strong> This class is part of work in progress and can be changed or removed without notice.
* *
* @see MojoExecutionListener * @see MojoExecutionListener
* @see org.apache.maven.execution.scope.WeakMojoExecutionListener * @see org.apache.maven.execution.scope.WeakMojoExecutionListener
* @since 3.1.2 * @since 3.1.2
* @provisional This class is part of work in progress and can be changed or removed without notice.
*/ */
public class MojoExecutionEvent public class MojoExecutionEvent
{ {

View File

@ -22,11 +22,13 @@ package org.apache.maven.execution;
import org.apache.maven.plugin.MojoExecutionException; import org.apache.maven.plugin.MojoExecutionException;
/** /**
* <p>
* Extension point that allows build extensions observe and possibly veto mojo executions. * Extension point that allows build extensions observe and possibly veto mojo executions.
* </p>
* <strong>Note:</strong> This interface is part of work in progress and can be changed or removed without notice.
* *
* @see org.apache.maven.execution.scope.WeakMojoExecutionListener * @see org.apache.maven.execution.scope.WeakMojoExecutionListener
* @since 3.1.2 * @since 3.1.2
* @provisional This interface is part of work in progress and can be changed or removed without notice.
*/ */
public interface MojoExecutionListener public interface MojoExecutionListener
{ {

View File

@ -25,12 +25,14 @@ import org.apache.maven.plugin.MojoExecution;
import org.apache.maven.project.MavenProject; import org.apache.maven.project.MavenProject;
/** /**
* <p>
* Encapsulates parameters of ProjectExecutionListener callback methods and is meant to provide API evolution path * Encapsulates parameters of ProjectExecutionListener callback methods and is meant to provide API evolution path
* should it become necessary to introduce new parameters in the existing callbacks in the future. * should it become necessary to introduce new parameters in the existing callbacks in the future.
* </p>
* <strong>Note:</strong> This class is part of work in progress and can be changed or removed without notice.
* *
* @see ProjectExecutionListener * @see ProjectExecutionListener
* @since 3.1.2 * @since 3.1.2
* @provisional This class is part of work in progress and can be changed or removed without notice.
*/ */
public class ProjectExecutionEvent public class ProjectExecutionEvent
{ {

View File

@ -22,12 +22,14 @@ package org.apache.maven.execution;
import org.apache.maven.lifecycle.LifecycleExecutionException; import org.apache.maven.lifecycle.LifecycleExecutionException;
/** /**
* <p>
* Extension point that allows build extensions observe and possibly veto project build execution. * Extension point that allows build extensions observe and possibly veto project build execution.
* </p>
* <strong>Note:</strong> This interface is part of work in progress and can be changed or removed without notice.
* *
* @see ExecutionListener * @see ExecutionListener
* @see MojoExecutionListener * @see MojoExecutionListener
* @since 3.1.2 * @since 3.1.2
* @provisional This interface is part of work in progress and can be changed or removed without notice.
*/ */
public interface ProjectExecutionListener public interface ProjectExecutionListener
{ {

View File

@ -28,10 +28,11 @@ import org.apache.maven.plugin.MojoExecutionException;
* Unlike {@link org.apache.maven.execution.MojoExecutionListener}, this extension point does not * Unlike {@link org.apache.maven.execution.MojoExecutionListener}, this extension point does not
* trigger instantiation of the component, hence "weak" class name prefix. Only applies to mojo execution * trigger instantiation of the component, hence "weak" class name prefix. Only applies to mojo execution
* scoped components. * scoped components.
* </p>
* <strong>Note:</strong> This interface is part of work in progress and can be changed or removed without notice.
* *
* @see org.apache.maven.execution.MojoExecutionListener * @see org.apache.maven.execution.MojoExecutionListener
* @since 3.1.2 * @since 3.1.2
* @provisional This interface is part of work in progress and can be changed or removed without notice.
*/ */
public interface WeakMojoExecutionListener public interface WeakMojoExecutionListener
{ {

View File

@ -23,10 +23,11 @@ import org.apache.maven.plugin.MojoExecution;
import org.apache.maven.project.MavenProject; import org.apache.maven.project.MavenProject;
/** /**
* <p>
* A MojoExecutionConfigurator is responsible for creating the configuration for Mojo based on configuration for a Mojo * A MojoExecutionConfigurator is responsible for creating the configuration for Mojo based on configuration for a Mojo
* in the MavenProject and the default configuration for the Mojo from the containing plugin's plugin.xml descriptor. * in the MavenProject and the default configuration for the Mojo from the containing plugin's plugin.xml descriptor.
* * </p>
* @provisional * <strong>Note:</strong> This interface is part of work in progress and can be changed or removed without notice.
* @author Jason van Zyl * @author Jason van Zyl
* @since 3.3.1, MNG-5753 * @since 3.3.1, MNG-5753
*/ */

View File

@ -29,9 +29,10 @@ import java.util.Collections;
import java.util.List; import java.util.List;
/** /**
* <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
*
* @since 3.0 * @since 3.0
* @author Kristian Rosenvold * @author Kristian Rosenvold
* This class is not part of any public api and can be changed or deleted without prior notice.
*/ */
@Component( role = BuildListCalculator.class ) @Component( role = BuildListCalculator.class )
public class BuildListCalculator public class BuildListCalculator

View File

@ -62,11 +62,11 @@ import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableMap;
/** /**
* <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
*
* @since 3.0 * @since 3.0
* @author Benjamin Bentmann * @author Benjamin Bentmann
* @author Kristian Rosenvold (Extract class) * @author Kristian Rosenvold (Extract class)
* <p/>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
*/ */
@Component( role = LifecycleExecutionPlanCalculator.class ) @Component( role = LifecycleExecutionPlanCalculator.class )
public class DefaultLifecycleExecutionPlanCalculator public class DefaultLifecycleExecutionPlanCalculator

View File

@ -42,13 +42,13 @@ import java.util.Map;
import java.util.Set; import java.util.Set;
/** /**
* <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
*
* @since 3.0 * @since 3.0
* @author Benjamin Bentmann * @author Benjamin Bentmann
* @author Jason van Zyl * @author Jason van Zyl
* @author jdcasey * @author jdcasey
* @author Kristian Rosenvold (extracted class only) * @author Kristian Rosenvold (extracted class only)
* <p/>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
*/ */
@Component( role = LifeCyclePluginAnalyzer.class ) @Component( role = LifeCyclePluginAnalyzer.class )
public class DefaultLifecyclePluginAnalyzer public class DefaultLifecyclePluginAnalyzer

View File

@ -40,17 +40,17 @@ import java.util.Arrays;
import java.util.List; import java.util.List;
/** /**
* <p>
* Calculates the task segments in the build * Calculates the task segments in the build
* </p>
* <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
* *
* @since 3.0 * @since 3.0
* @author Benjamin Bentmann * @author Benjamin Bentmann
* @author Jason van Zyl * @author Jason van Zyl
* @author jdcasey * @author jdcasey
* @author Kristian Rosenvold (extracted class) * @author Kristian Rosenvold (extracted class)
* <p/>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
*/ */
@Component( role = LifecycleTaskSegmentCalculator.class ) @Component( role = LifecycleTaskSegmentCalculator.class )
public class DefaultLifecycleTaskSegmentCalculator public class DefaultLifecycleTaskSegmentCalculator
implements LifecycleTaskSegmentCalculator implements LifecycleTaskSegmentCalculator

View File

@ -27,13 +27,14 @@ import java.util.Collections;
import java.util.TreeSet; import java.util.TreeSet;
/** /**
* <p>
* Context of dependency artifacts for a particular project. * Context of dependency artifacts for a particular project.
* </p>
* <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
* *
* @since 3.0 * @since 3.0
* @author Benjamin Bentmann * @author Benjamin Bentmann
* @author Kristian Rosenvold (class extract only) * @author Kristian Rosenvold (class extract only)
* <p/>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
*/ */
// TODO From a concurrency perspective, this class is not good. The combination of mutable/immutable state is not nice // TODO From a concurrency perspective, this class is not good. The combination of mutable/immutable state is not nice
public class DependencyContext public class DependencyContext

View File

@ -29,9 +29,10 @@ import java.util.ArrayList;
import java.util.List; import java.util.List;
/** /**
* <p>
* Wraps individual MojoExecutions, containing information about completion status and scheduling. * Wraps individual MojoExecutions, containing information about completion status and scheduling.
* <p/> * </p>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice. * <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
* *
* @since 3.0 * @since 3.0
* @author Kristian Rosenvold * @author Kristian Rosenvold

View File

@ -20,9 +20,10 @@ package org.apache.maven.lifecycle.internal;
*/ */
/** /**
* <p>
* A task that is a goal * A task that is a goal
* <p/> * </p>
* TODO From a concurrency perspective, this class is not good. The combination of mutable/immutable state is not nice * <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
* *
* @since 3.0 * @since 3.0
* @author Benjamin Bentmann * @author Benjamin Bentmann

View File

@ -36,14 +36,15 @@ import java.util.Set;
import java.util.TreeSet; import java.util.TreeSet;
/** /**
* <p>
* Logs debug output from the various lifecycle phases. * Logs debug output from the various lifecycle phases.
* </p>
* <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
* *
* @since 3.0 * @since 3.0
* @author Benjamin Bentmann * @author Benjamin Bentmann
* @author Jason van Zyl * @author Jason van Zyl
* @author Kristian Rosenvold (extracted class only) * @author Kristian Rosenvold (extracted class only)
* <p/>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
*/ */
@Component( role = LifecycleDebugLogger.class ) @Component( role = LifecycleDebugLogger.class )
public class LifecycleDebugLogger public class LifecycleDebugLogger

View File

@ -51,14 +51,14 @@ import org.eclipse.aether.util.filter.AndDependencyFilter;
import org.eclipse.aether.util.filter.ScopeDependencyFilter; import org.eclipse.aether.util.filter.ScopeDependencyFilter;
/** /**
* <p>
* Resolves dependencies for the artifacts in context of the lifecycle build * Resolves dependencies for the artifacts in context of the lifecycle build
* * </p>
* <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
* @since 3.0 * @since 3.0
* @author Benjamin Bentmann * @author Benjamin Bentmann
* @author Jason van Zyl * @author Jason van Zyl
* @author Kristian Rosenvold (extracted class) * @author Kristian Rosenvold (extracted class)
* <p/>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
*/ */
@Named @Named
public class LifecycleDependencyResolver public class LifecycleDependencyResolver

View File

@ -39,7 +39,6 @@ import java.util.List;
* @since 3.0 * @since 3.0
* @author Benjamin Bentmann * @author Benjamin Bentmann
* @author Kristian Rosenvold (extract interface only) * @author Kristian Rosenvold (extract interface only)
* <p/>
*/ */
public interface LifecycleExecutionPlanCalculator public interface LifecycleExecutionPlanCalculator
{ {

View File

@ -37,14 +37,15 @@ import org.codehaus.plexus.component.annotations.Component;
import org.codehaus.plexus.component.annotations.Requirement; import org.codehaus.plexus.component.annotations.Requirement;
/** /**
* <p>
* Builds one or more lifecycles for a full module * Builds one or more lifecycles for a full module
* </p>
* <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
* *
* @since 3.0 * @since 3.0
* @author Benjamin Bentmann * @author Benjamin Bentmann
* @author Jason van Zyl * @author Jason van Zyl
* @author Kristian Rosenvold (extracted class) * @author Kristian Rosenvold (extracted class)
* <p/>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
*/ */
@Component( role = LifecycleModuleBuilder.class ) @Component( role = LifecycleModuleBuilder.class )
public class LifecycleModuleBuilder public class LifecycleModuleBuilder

View File

@ -34,11 +34,10 @@ import org.codehaus.plexus.component.annotations.Component;
import org.codehaus.plexus.component.annotations.Requirement; import org.codehaus.plexus.component.annotations.Requirement;
/** /**
* <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
* @since 3.0 * @since 3.0
* @author Benjamin Bentmann * @author Benjamin Bentmann
* @author Kristian Rosenvold (Extract class) * @author Kristian Rosenvold (Extract class)
* <p/>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
*/ */
@Component( role = LifecyclePluginResolver.class ) @Component( role = LifecyclePluginResolver.class )
public class LifecyclePluginResolver public class LifecyclePluginResolver

View File

@ -20,9 +20,10 @@ package org.apache.maven.lifecycle.internal;
*/ */
/** /**
* <p>
* A task that is a lifecycle * A task that is a lifecycle
* <p/> * </p>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice. * <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
* *
* @since 3.0 * @since 3.0
* @author Benjamin Bentmann * @author Benjamin Bentmann

View File

@ -33,17 +33,17 @@ import org.apache.maven.plugin.version.PluginVersionResolutionException;
import java.util.List; import java.util.List;
/** /**
* <p>
* Calculates the task segments in the build * Calculates the task segments in the build
* </p>
* <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
* *
* @since 3.0 * @since 3.0
* @author Benjamin Bentmann * @author Benjamin Bentmann
* @author Jason van Zyl * @author Jason van Zyl
* @author jdcasey * @author jdcasey
* @author Kristian Rosenvold (extracted interface) * @author Kristian Rosenvold (extracted interface)
* <p/>
* NOTE: This interface is not part of any public api and can be changed or deleted without prior notice.
*/ */
public interface LifecycleTaskSegmentCalculator public interface LifecycleTaskSegmentCalculator
{ {
List<TaskSegment> calculateTaskSegments( MavenSession session ) List<TaskSegment> calculateTaskSegments( MavenSession session )

View File

@ -49,15 +49,16 @@ import java.util.Collection;
import java.util.StringTokenizer; import java.util.StringTokenizer;
/** /**
* <p>
* Resolves dependencies for the artifacts in context of the lifecycle build * Resolves dependencies for the artifacts in context of the lifecycle build
* </p>
* <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
* *
* @since 3.0 * @since 3.0
* @author Benjamin Bentmann * @author Benjamin Bentmann
* @author Jason van Zyl * @author Jason van Zyl
* @author jdcasey * @author jdcasey
* @author Kristian Rosenvold (extracted class only) * @author Kristian Rosenvold (extracted class only)
* <p/>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
*/ */
@Component( role = MojoDescriptorCreator.class ) @Component( role = MojoDescriptorCreator.class )
public class MojoDescriptorCreator public class MojoDescriptorCreator

View File

@ -50,13 +50,14 @@ import java.util.Set;
import java.util.TreeSet; import java.util.TreeSet;
/** /**
* <p>
* Executes an individual mojo * Executes an individual mojo
* </p>
* <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
* *
* @author Jason van Zyl * @author Jason van Zyl
* @author Benjamin Bentmann * @author Benjamin Bentmann
* @author Kristian Rosenvold * @author Kristian Rosenvold
* <p/>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
* @since 3.0 * @since 3.0
*/ */
@Component( role = MojoExecutor.class ) @Component( role = MojoExecutor.class )

View File

@ -23,11 +23,10 @@ import org.apache.maven.plugin.MojoExecution;
import org.apache.maven.project.MavenProject; import org.apache.maven.project.MavenProject;
/** /**
* <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
* @since 3.0 * @since 3.0
* @author Benjamin Bentmann * @author Benjamin Bentmann
* @author Kristian Rosenvold * @author Kristian Rosenvold
* <p/>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
*/ */
public class PhaseRecorder public class PhaseRecorder
{ {

View File

@ -26,10 +26,12 @@ import org.apache.maven.project.MavenProject;
import org.apache.maven.project.artifact.InvalidDependencyVersionException; import org.apache.maven.project.artifact.InvalidDependencyVersionException;
/** /**
* <p>
* Component interface responsible for creation of MavenProject#dependencyArtifacts instances. * Component interface responsible for creation of MavenProject#dependencyArtifacts instances.
* </p>
* <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
* *
* @since 3.2.4 * @since 3.2.4
* @provisional This interface is part of work in progress and can be changed or removed without notice.
*/ */
public interface ProjectArtifactFactory public interface ProjectArtifactFactory
{ {

View File

@ -33,13 +33,14 @@ import org.apache.maven.execution.MavenSession;
import org.apache.maven.project.MavenProject; import org.apache.maven.project.MavenProject;
/** /**
* <p>
* A list of project segments, ordered so that all ProjectSegments from first TaskSegment come before any * A list of project segments, ordered so that all ProjectSegments from first TaskSegment come before any
* subsequent TaskSegments. * subsequent TaskSegments.
* </p>
* <strong>Note:</strong> This interface is part of work in progress and can be changed or removed without notice.
* *
* @since 3.0 * @since 3.0
* @author Kristian Rosenvold * @author Kristian Rosenvold
* <p/>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
*/ */
public class ProjectBuildList public class ProjectBuildList
implements Iterable<ProjectSegment> implements Iterable<ProjectSegment>

View File

@ -27,13 +27,14 @@ import java.util.List;
import java.util.Map; import java.util.Map;
/** /**
* <p>
* Provides the positional index of the project * Provides the positional index of the project
* </p>
* <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
* *
* @since 3.0 * @since 3.0
* @author Benjamin Bentmann * @author Benjamin Bentmann
* @author Kristian Rosenvold (extracted class only) * @author Kristian Rosenvold (extracted class only)
* <p/>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
*/ */
// TODO Kristian wonders if this class really is necessary and if it overlaps other concepts. // TODO Kristian wonders if this class really is necessary and if it overlaps other concepts.
public final class ProjectIndex public final class ProjectIndex

View File

@ -27,29 +27,33 @@ import java.util.List;
/** /**
* A build context that matches a mavenproject to a given tasksegment, and the session to be used. * A build context that matches a mavenproject to a given tasksegment, and the session to be used.
* <p/> * <p>
* A note to the reader; * A note to the reader;
* <p/> * </p>
* <p>
* There are several issues/discussions regarding how "aggregator" plugins should be handled. * There are several issues/discussions regarding how "aggregator" plugins should be handled.
* Read for instance http://docs.codehaus.org/display/MAVEN/Deterministic+Lifecycle+Planning * Read for instance http://docs.codehaus.org/display/MAVEN/Deterministic+Lifecycle+Planning
* <p/> * </p>
* <p>
* In their current implementation they are "bolted" onto the lifecycle by separating them * In their current implementation they are "bolted" onto the lifecycle by separating them
* into TaskSegments. This class represents the execution context of one such task segment. * into TaskSegments. This class represents the execution context of one such task segment.
* <p/> * </p>
* <p>
* Wise voices have suggested that maybe aggregators shouldn't be bound to the ordinary * Wise voices have suggested that maybe aggregators shouldn't be bound to the ordinary
* lifecycle at all, in which case we wouldn't be needing this class at all ( and * lifecycle at all, in which case we wouldn't be needing this class at all ( and
* ProjectBuildList.getByTaskSegments). Or maybe they should be introduced in the calculation * ProjectBuildList.getByTaskSegments). Or maybe they should be introduced in the calculation
* of the execution plan instead, which seems much nicer. * of the execution plan instead, which seems much nicer.
* <p/> * </p>
* <p>
* Additionally this class contains a clone of the MavenSession, which is *only* needed * Additionally this class contains a clone of the MavenSession, which is *only* needed
* because it has as notion of a "current" project. * because it has as notion of a "current" project.
* </p>
* <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
* *
* @since 3.0 * @since 3.0
* @author Jason van Zyl * @author Jason van Zyl
* @author Benjamin Bentmann * @author Benjamin Bentmann
* @author Kristian Rosenvold * @author Kristian Rosenvold
* <p/>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
*/ */
public final class ProjectSegment public final class ProjectSegment
{ {

View File

@ -26,11 +26,11 @@ import java.util.List;
/** /**
* Describes the required task segment as provided on the maven command line; i.e. "clean jetty:run install" * Describes the required task segment as provided on the maven command line; i.e. "clean jetty:run install"
* *
* <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
*
* @since 3.0 * @since 3.0
* @author Benjamin Bentmann * @author Benjamin Bentmann
* @author Kristian Rosenvold (extracted class only) * @author Kristian Rosenvold (extracted class only)
* <p/>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
*/ */
public final class TaskSegment public final class TaskSegment
{ {

View File

@ -29,11 +29,12 @@ import org.apache.maven.lifecycle.internal.ReactorContext;
import org.apache.maven.lifecycle.internal.TaskSegment; import org.apache.maven.lifecycle.internal.TaskSegment;
/** /**
* <p>
* A {@link Builder} encapsulates a strategy for building a set of Maven projects. The default strategy in Maven builds * A {@link Builder} encapsulates a strategy for building a set of Maven projects. The default strategy in Maven builds
* the the projects serially, but a {@link Builder} can employ any type of concurrency model to build the projects. * the the projects serially, but a {@link Builder} can employ any type of concurrency model to build the projects.
* * </p>
* <strong>Note:</strong> This interface is part of work in progress and can be changed or removed without notice.
* @author jvanzyl * @author jvanzyl
* @provisional
*/ */
public interface Builder public interface Builder
{ {

View File

@ -30,12 +30,13 @@ import java.util.List;
import java.util.Set; import java.util.Set;
/** /**
* <p>
* Presents a view of the Dependency Graph that is suited for concurrent building. * Presents a view of the Dependency Graph that is suited for concurrent building.
* </p>
* <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
* *
* @since 3.0 * @since 3.0
* @author Kristian Rosenvold * @author Kristian Rosenvold
* <p/>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
*/ */
public class ConcurrencyDependencyGraph public class ConcurrencyDependencyGraph
{ {

View File

@ -49,12 +49,12 @@ import org.codehaus.plexus.logging.Logger;
* This builder uses a number of threads equal to the minimum of the degree of concurrency (which is the thread count * This builder uses a number of threads equal to the minimum of the degree of concurrency (which is the thread count
* set with <code>-T</code> on the command-line) and the number of projects to build. As such, building a single project * set with <code>-T</code> on the command-line) and the number of projects to build. As such, building a single project
* will always result in a sequential build, regardless of the thread count. * will always result in a sequential build, regardless of the thread count.
* </p>
* <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
* *
* @since 3.0 * @since 3.0
* @author Kristian Rosenvold * @author Kristian Rosenvold
* Builds one or more lifecycles for a full module * Builds one or more lifecycles for a full module
* <p/>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
*/ */
@Component( role = Builder.class, hint = "multithreaded" ) @Component( role = Builder.class, hint = "multithreaded" )
public class MultiThreadedBuilder public class MultiThreadedBuilder

View File

@ -33,12 +33,12 @@ import org.apache.maven.lifecycle.internal.ProjectBuildList;
import org.apache.maven.lifecycle.internal.ProjectSegment; import org.apache.maven.lifecycle.internal.ProjectSegment;
/** /**
* @since 3.0 * <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
* @author Kristian Rosenvold
* <p/>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
* This class in particular may spontaneously self-combust and be replaced by a plexus-compliant thread aware * This class in particular may spontaneously self-combust and be replaced by a plexus-compliant thread aware
* logger implementation at any time. * logger implementation at any time.
*
* @since 3.0
* @author Kristian Rosenvold
*/ */
@SuppressWarnings( { "SynchronizationOnLocalVariableOrMethodParameter" } ) @SuppressWarnings( { "SynchronizationOnLocalVariableOrMethodParameter" } )
public class ThreadOutputMuxer public class ThreadOutputMuxer

View File

@ -34,7 +34,7 @@ import org.codehaus.plexus.util.introspection.ReflectionValueExtractor;
/** /**
* Evaluator for plugin parameters expressions. Content surrounded by <code>${</code> and <code>}</code> is evaluated. * Evaluator for plugin parameters expressions. Content surrounded by <code>${</code> and <code>}</code> is evaluated.
* Recognized values are:<table border="1"> * Recognized values are:<table border="1" summary="Expression matrix">
* <tr><th>expression</th> <th></th> <th>evaluation result</th></tr> * <tr><th>expression</th> <th></th> <th>evaluation result</th></tr>
* <tr><td><code>session</code></td> <td></td> <td>the actual {@link MavenSession}</td></tr> * <tr><td><code>session</code></td> <td></td> <td>the actual {@link MavenSession}</td></tr>
* <tr><td><code>session.*</code></td> <td>(since Maven 3)</td><td></td></tr> * <tr><td><code>session.*</code></td> <td>(since Maven 3)</td><td></td></tr>

View File

@ -121,10 +121,12 @@ public class DefaultMavenPluginManager
{ {
/** /**
* PluginId=>ExtensionRealmCache.CacheRecord map MavenProject context value key. The map is used to ensure the same * <p>
* class realm is used to load build extensions and load mojos for extensions=true plugins. * PluginId =&gt; ExtensionRealmCache.CacheRecord map MavenProject context value key. The map is used to ensure the
* same class realm is used to load build extensions and load mojos for extensions=true plugins.
* </p>
* <strong>Note:</strong> This is part of internal implementation and may be changed or removed without notice
* *
* @provisional This is part of internal implementation and may be changed or removed without notice
* @since 3.3.0 * @since 3.3.0
*/ */
public static final String KEY_EXTENSIONS_REALMS = DefaultMavenPluginManager.class.getName() + "/extensionsRealms"; public static final String KEY_EXTENSIONS_REALMS = DefaultMavenPluginManager.class.getName() + "/extensionsRealms";

View File

@ -74,11 +74,11 @@ import org.eclipse.aether.repository.RemoteRepository;
/** /**
* The concern of the project is provide runtime values based on the model. * The concern of the project is provide runtime values based on the model.
* <p/> * <p>
* The values in the model remain untouched but during the process of building a project notions like inheritance and * The values in the model remain untouched but during the process of building a project notions like inheritance and
* interpolation can be added. This allows to have an entity which is useful in a runtime while preserving the model so * interpolation can be added. This allows to have an entity which is useful in a runtime while preserving the model so
* that it can be marshalled and unmarshalled without being tainted by runtime requirements. * that it can be marshalled and unmarshalled without being tainted by runtime requirements.
* <p/> * </p>
* <p> * <p>
* With changes during 3.2.2 release MavenProject is closer to being immutable after construction with the removal of * With changes during 3.2.2 release MavenProject is closer to being immutable after construction with the removal of
* all components from this class, and the upfront construction taken care of entirely by the @{ProjectBuilder}. There * all components from this class, and the upfront construction taken care of entirely by the @{ProjectBuilder}. There
@ -696,7 +696,7 @@ public class MavenProject
* what phases have run dependencies in some scopes won't be included. eg. if only compile phase has run, * what phases have run dependencies in some scopes won't be included. eg. if only compile phase has run,
* dependencies with scope test won't be included. * dependencies with scope test won't be included.
* *
* @return {@link Set} &lt; {@link Artifact} > * @return {@link Set} &lt; {@link Artifact} &gt;
* @see #getDependencyArtifacts() to get only direct dependencies * @see #getDependencyArtifacts() to get only direct dependencies
*/ */
public Set<Artifact> getArtifacts() public Set<Artifact> getArtifacts()
@ -992,7 +992,7 @@ public class MavenProject
/** /**
* Direct dependencies that this project has. * Direct dependencies that this project has.
* *
* @return {@link Set} &lt; {@link Artifact} > * @return {@link Set} &lt; {@link Artifact} &gt;
* @see #getArtifacts() to get all transitive dependencies * @see #getArtifacts() to get all transitive dependencies
*/ */
@Deprecated @Deprecated
@ -1152,7 +1152,6 @@ public class MavenProject
} }
/** /**
* @throws CloneNotSupportedException
* @since 2.0.9 * @since 2.0.9
*/ */
@Override @Override

View File

@ -24,8 +24,8 @@ import org.eclipse.aether.RepositorySystemSession;
/** /**
* Component interface that allows per-project customization of Aether repository system sessions. * Component interface that allows per-project customization of Aether repository system sessions.
* *
* <strong>Note:</strong> This interface is part of work in progress and can be changed or removed without notice.
* @since 3.2.4 * @since 3.2.4
* @provisional This interface is part of work in progress and can be changed or removed without notice.
*/ */
public interface RepositorySessionDecorator public interface RepositorySessionDecorator
{ {

View File

@ -122,7 +122,7 @@ public class ArtifactTransferEvent
* Returns the request type. * Returns the request type.
* *
* @return Returns the request type. The Request type is one of * @return Returns the request type. The Request type is one of
* <code>TransferEvent.REQUEST_GET<code> or <code>TransferEvent.REQUEST_PUT<code> * <code>TransferEvent.REQUEST_GET</code> or <code>TransferEvent.REQUEST_PUT</code>
*/ */
public int getRequestType() public int getRequestType()
{ {
@ -134,7 +134,7 @@ public class ArtifactTransferEvent
* *
* @param requestType The requestType to set. * @param requestType The requestType to set.
* The Request type value should be either * The Request type value should be either
* <code>TransferEvent.REQUEST_GET<code> or <code>TransferEvent.REQUEST_PUT<code>. * <code>TransferEvent.REQUEST_GET</code> or <code>TransferEvent.REQUEST_PUT</code>.
* @throws IllegalArgumentException when * @throws IllegalArgumentException when
*/ */
public void setRequestType( final int requestType ) public void setRequestType( final int requestType )

View File

@ -48,8 +48,8 @@ public interface ArtifactMetadataSource
* are needed, for instance the following code will work * are needed, for instance the following code will work
* <code>artifactFactory.createProjectArtifact( "org.apache.maven", "maven", "" )</code> * <code>artifactFactory.createProjectArtifact( "org.apache.maven", "maven", "" )</code>
* @param localRepository local repository * @param localRepository local repository
* @param remoteRepositories remote repositories, {@link List} $lt; {@link ArtifactRepository} > * @param remoteRepositories remote repositories, {@link List} $lt; {@link ArtifactRepository} &gt;
* @return {@link List} $lt; {@link ArtifactVersion} > * @return {@link List} $lt; {@link ArtifactVersion} &gt;
* @throws ArtifactMetadataRetrievalException * @throws ArtifactMetadataRetrievalException
* in case of error while retrieving repository metadata from the repository. * in case of error while retrieving repository metadata from the repository.
*/ */
@ -66,7 +66,7 @@ public interface ArtifactMetadataSource
* <code>artifactFactory.createProjectArtifact( "org.apache.maven", "maven", "" )</code> * <code>artifactFactory.createProjectArtifact( "org.apache.maven", "maven", "" )</code>
* @param localRepository local repository * @param localRepository local repository
* @param remoteRepository remote repository * @param remoteRepository remote repository
* @return {@link List} $lt; {@link ArtifactVersion} > * @return {@link List} $lt; {@link ArtifactVersion} &gt;
* @throws ArtifactMetadataRetrievalException * @throws ArtifactMetadataRetrievalException
* in case of error while retrieving repository metadata from the repository. * in case of error while retrieving repository metadata from the repository.
*/ */

View File

@ -34,7 +34,7 @@ public interface ToolchainPrivate
/** /**
* Let the toolchain decide if it matches requirements defined * Let the toolchain decide if it matches requirements defined
* in the toolchain plugin configuration. * in the toolchain plugin configuration.
* @param requirements Map<String, String> key value pair, may not be {@code null} * @param requirements Map&lt;String, String&gt; key value pair, may not be {@code null}
* @return {@code true} if the requirements match, otherwise {@code false} * @return {@code true} if the requirements match, otherwise {@code false}
*/ */
boolean matchesRequirements( Map<String, String> requirements ); boolean matchesRequirements( Map<String, String> requirements );

View File

@ -117,7 +117,6 @@ import static org.apache.maven.shared.utils.logging.MessageUtils.buffer;
/** /**
* @author Jason van Zyl * @author Jason van Zyl
* @noinspection UseOfSystemOutOrSystemErr, ACCESS_STATIC_VIA_INSTANCE
*/ */
public class MavenCli public class MavenCli
{ {
@ -195,9 +194,6 @@ public class MavenCli
System.exit( result ); System.exit( result );
} }
/**
* @noinspection ConfusingMainMethod
*/
public static int main( String[] args, ClassWorld classWorld ) public static int main( String[] args, ClassWorld classWorld )
{ {
MavenCli cli = new MavenCli(); MavenCli cli = new MavenCli();

View File

@ -291,10 +291,12 @@ public class ExecutionEventLogger
} }
} }
// CHECKSTYLE_OFF: LineLength
/** /**
* <pre>>>> mojo-artifactId:version:goal (mojo-executionId) > :forked-goal @ project-artifactId >>></pre> * <pre>&gt;&gt;&gt; mojo-artifactId:version:goal (mojo-executionId) &gt; :forked-goal @ project-artifactId &gt;&gt;&gt;</pre>
* <pre>>>> mojo-artifactId:version:goal (mojo-executionId) > [lifecycle]phase @ project-artifactId >>></pre> * <pre>&gt;&gt;&gt; mojo-artifactId:version:goal (mojo-executionId) &gt; [lifecycle]phase @ project-artifactId &gt;&gt;&gt;</pre>
*/ */
// CHECKSTYLE_ON: LineLength
@Override @Override
public void forkStarted( ExecutionEvent event ) public void forkStarted( ExecutionEvent event )
{ {

View File

@ -30,8 +30,6 @@ import java.io.File;
* calculated from the elements of the model itself and the execution properties from the building request. * calculated from the elements of the model itself and the execution properties from the building request.
* *
* @author jdcasey * @author jdcasey
* <p/>
* Created on Feb 2, 2005
*/ */
public interface ModelInterpolator public interface ModelInterpolator
{ {

View File

@ -74,9 +74,9 @@ import org.codehaus.plexus.util.xml.Xpp3Dom;
* This is a hand-crafted prototype of the default model merger that should eventually be generated by Modello by a new * This is a hand-crafted prototype of the default model merger that should eventually be generated by Modello by a new
* Java plugin. Code structure to merge source (read-only) object into the target object is:<ul> * Java plugin. Code structure to merge source (read-only) object into the target object is:<ul>
* <li><code>merge<i>Classname</i>( <i>Classname</i> target, <i>Classname</i> source, boolean sourceDominant, * <li><code>merge<i>Classname</i>( <i>Classname</i> target, <i>Classname</i> source, boolean sourceDominant,
* Map<Object, Object> context )</code> for each model class</li> * Map&lt;Object, Object&gt; context )</code> for each model class</li>
* <li><code>merge<i>Classname</i>_<i>FieldName</i>( <i>Classname</i> target, <i>Classname</i> source, boolean * <li><code>merge<i>Classname</i>_<i>FieldName</i>( <i>Classname</i> target, <i>Classname</i> source, boolean
* sourceDominant, Map<Object, Object> context )</code> for each field of each model class</li> * sourceDominant, Map&lt;Object, Object&gt; context )</code> for each field of each model class</li>
* <li><code>Object get<i>Classname</i>Key( <i>Classname</i> <i>classname</i> )</code> * <li><code>Object get<i>Classname</i>Key( <i>Classname</i> <i>classname</i> )</code>
* for each class that is used in a list</li> * for each class that is used in a list</li>
* </ul> * </ul>

View File

@ -245,7 +245,7 @@
<description> <description>
<![CDATA[ <![CDATA[
The URL to the project's homepage. The URL to the project's homepage.
<br /><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or <code>project.directory</code> property) <br><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or <code>project.directory</code> property)
]]> ]]>
</description> </description>
<type>String</type> <type>String</type>
@ -2142,7 +2142,7 @@
<a href="https://maven.apache.org/scm/scm-url-format.html">URL format</a> <a href="https://maven.apache.org/scm/scm-url-format.html">URL format</a>
and <a href="https://maven.apache.org/scm/scms-overview.html">list of supported SCMs</a>. and <a href="https://maven.apache.org/scm/scms-overview.html">list of supported SCMs</a>.
This connection is read-only. This connection is read-only.
<br /><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or <code>project.directory</code> property) <br><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or <code>project.directory</code> property)
]]> ]]>
</description> </description>
<type>String</type> <type>String</type>
@ -2154,7 +2154,7 @@
<![CDATA[ <![CDATA[
Just like <code>connection</code>, but for developers, i.e. this scm connection Just like <code>connection</code>, but for developers, i.e. this scm connection
will not be read only. will not be read only.
<br /><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or <code>project.directory</code> property) <br><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or <code>project.directory</code> property)
]]> ]]>
</description> </description>
<type>String</type> <type>String</type>
@ -2172,7 +2172,7 @@
<description> <description>
<![CDATA[ <![CDATA[
The URL to the project's browsable SCM repository, such as ViewVC or Fisheye. The URL to the project's browsable SCM repository, such as ViewVC or Fisheye.
<br /><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or <code>project.directory</code> property) <br><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or <code>project.directory</code> property)
]]> ]]>
</description> </description>
<type>String</type> <type>String</type>
@ -2605,7 +2605,7 @@
<description> <description>
<![CDATA[ <![CDATA[
The url of the location where website is deployed, in the form <code>protocol://hostname/path</code>. The url of the location where website is deployed, in the form <code>protocol://hostname/path</code>.
<br /><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or <code>project.directory</code> property) <br><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or <code>project.directory</code> property)
]]> ]]>
</description> </description>
<type>String</type> <type>String</type>
@ -3282,7 +3282,7 @@
<description><![CDATA[This is the file specification used to activate the profile. The <code>missing</code> value <description><![CDATA[This is the file specification used to activate the profile. The <code>missing</code> value
is the location of a file that needs to exist, and if it doesn't, the profile will be is the location of a file that needs to exist, and if it doesn't, the profile will be
activated. On the other hand, <code>exists</code> will test for the existence of the file and if it is activated. On the other hand, <code>exists</code> will test for the existence of the file and if it is
there, the profile will be activated.<br/> there, the profile will be activated.<br>
Variable interpolation for these file specifications is limited to <code>${basedir}</code>, Variable interpolation for these file specifications is limited to <code>${basedir}</code>,
System properties and request properties.]]></description> System properties and request properties.]]></description>
<fields> <fields>
@ -3484,7 +3484,7 @@
<defaultValue>2.0</defaultValue> <defaultValue>2.0</defaultValue>
<description><![CDATA[ <description><![CDATA[
For a plugin project (packaging is <code>maven-plugin</code>), the minimum version of For a plugin project (packaging is <code>maven-plugin</code>), the minimum version of
Maven required to use the resulting plugin.<br /> Maven required to use the resulting plugin.<br>
In Maven 2, this was also specifying the minimum version of Maven required to build a In Maven 2, this was also specifying the minimum version of Maven required to build a
project, but this usage is <b>deprecated</b> in Maven 3 and not checked any more: use project, but this usage is <b>deprecated</b> in Maven 3 and not checked any more: use
the <a href="https://maven.apache.org/enforcer/enforcer-rules/requireMavenVersion.html">Maven Enforcer Plugin's the <a href="https://maven.apache.org/enforcer/enforcer-rules/requireMavenVersion.html">Maven Enforcer Plugin's

View File

@ -26,21 +26,18 @@ import org.apache.maven.plugin.logging.SystemStreamLog;
/** /**
* Abstract class to provide most of the infrastructure required to implement a <code>Mojo</code> except for * Abstract class to provide most of the infrastructure required to implement a <code>Mojo</code> except for
* the execute method. * the execute method.<br>
* <br/>
* The implementation should have a <code>goal</code> annotation in the class-level javadoc annotation: * The implementation should have a <code>goal</code> annotation in the class-level javadoc annotation:
* <pre> * <pre>
* &#47;&#42;&#42; * &#47;&#42;&#42;
* &#42; &#64;goal goalName * &#42; &#64;goal goalName
* &#42;&#47; * &#42;&#47;
* </pre> * </pre>
* * <p>
* There are also a number of class-level javadoc annotations which can be used to control how and when the * There are also a number of class-level javadoc annotations which can be used to control how and when the
* <code>Mojo</code> is executed: * <code>Mojo</code> is executed:
* <br/> * </p>
* <br/> * <table border="1" summary="class-level doclettags">
*
* <table border="1">
* <tr bgcolor="#CCCCCC"> * <tr bgcolor="#CCCCCC">
* <th>Descriptor Element</th> * <th>Descriptor Element</th>
* <th>Annotation</th> * <th>Annotation</th>
@ -73,7 +70,7 @@ import org.apache.maven.plugin.logging.SystemStreamLog;
* <td>The configurator type to use when injecting parameter values into this Mojo. The value is normally * <td>The configurator type to use when injecting parameter values into this Mojo. The value is normally
* deduced from the Mojo's implementation language, but can be specified to allow a custom * deduced from the Mojo's implementation language, but can be specified to allow a custom
* ComponentConfigurator implementation to be used. * ComponentConfigurator implementation to be used.
* <br/> * <br>
* <i>NOTE: This will only be used in very special cases, using a highly controlled vocabulary of possible * <i>NOTE: This will only be used in very special cases, using a highly controlled vocabulary of possible
* values. (Elements like this are why it's a good idea to use the descriptor tools.)</i> * values. (Elements like this are why it's a good idea to use the descriptor tools.)</i>
* </td> * </td>
@ -83,7 +80,7 @@ import org.apache.maven.plugin.logging.SystemStreamLog;
* <td>@phase &lt;phaseName&gt;</td> * <td>@phase &lt;phaseName&gt;</td>
* <td>No</td> * <td>No</td>
* <td>Binds this Mojo to a particular phase of the standard build lifecycle, if specified. * <td>Binds this Mojo to a particular phase of the standard build lifecycle, if specified.
* <br/> * <br>
* <i>NOTE: This is only required if this Mojo is to participate in the standard build process.</i> * <i>NOTE: This is only required if this Mojo is to participate in the standard build process.</i>
* </td> * </td>
* </tr> * </tr>
@ -106,7 +103,7 @@ import org.apache.maven.plugin.logging.SystemStreamLog;
* <td>No</td> * <td>No</td>
* <td>Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope) to be * <td>Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope) to be
* resolved before it can execute. * resolved before it can execute.
* <br/> * <br>
* <i>NOTE: Currently supports <b>compile</b>, <b>runtime</b>, and <b>test</b> scopes.</i> * <i>NOTE: Currently supports <b>compile</b>, <b>runtime</b>, and <b>test</b> scopes.</i>
* </td> * </td>
* </tr> * </tr>
@ -114,9 +111,8 @@ import org.apache.maven.plugin.logging.SystemStreamLog;
* <td>description</td> * <td>description</td>
* <td>none (detected)</td> * <td>none (detected)</td>
* <td>No</td> * <td>No</td>
* <td>The description of this Mojo's functionality. <i>Using the toolset, this will be the class-level * <td>The description of this Mojo's functionality. Using the toolset, this will be the class-level
* Javadoc description provided. * Javadoc description provided.<br>
* <br/>
* <i>NOTE: While this is not a required part of the Mojo specification, it <b>SHOULD</b> be provided to * <i>NOTE: While this is not a required part of the Mojo specification, it <b>SHOULD</b> be provided to
* enable future tool support for browsing, etc. and for clarity.</i> * enable future tool support for browsing, etc. and for clarity.</i>
* </td> * </td>
@ -127,7 +123,7 @@ import org.apache.maven.plugin.logging.SystemStreamLog;
* <td>No</td> * <td>No</td>
* <td>Specifications for the parameters which this Mojo uses will be provided in <b>parameter</b> sub-elements * <td>Specifications for the parameters which this Mojo uses will be provided in <b>parameter</b> sub-elements
* in this section. * in this section.
* <br/> * <br>
* <i>NOTE: Parameters are discussed in more detail below.</i> * <i>NOTE: Parameters are discussed in more detail below.</i>
* </td> * </td>
* </tr> * </tr>
@ -159,9 +155,10 @@ public abstract class AbstractMojo
} }
/** /**
* <p>
* Returns the logger that has been injected into this mojo. If no logger has been setup yet, a * Returns the logger that has been injected into this mojo. If no logger has been setup yet, a
* <code>SystemStreamLog</code> logger will be created and returned. * <code>SystemStreamLog</code> logger will be created and returned.
* <br/><br/> * </p>
* <strong>Note:</strong> * <strong>Note:</strong>
* The logger returned by this method must not be cached in an instance field during the construction of the mojo. * The logger returned by this method must not be cached in an instance field during the construction of the mojo.
* This would cause the mojo to use a wrongly configured default logger when being run by Maven. The proper logger * This would cause the mojo to use a wrongly configured default logger when being run by Maven. The proper logger

View File

@ -23,8 +23,7 @@ import java.util.Map;
/** /**
* Interface to allow <code>Mojos</code> to communicate with each others <code>Mojos</code>, other than * Interface to allow <code>Mojos</code> to communicate with each others <code>Mojos</code>, other than
* project's source root and project's attachment. * project's source root and project's attachment.<br>
* <br/>
* The plugin manager would pull the context out of the plugin container context, and populate it into the Mojo. * The plugin manager would pull the context out of the plugin container context, and populate it into the Mojo.
* *
* @author jdcasey * @author jdcasey

View File

@ -23,11 +23,9 @@ import org.apache.maven.plugin.logging.Log;
/** /**
* This interface forms the contract required for <code>Mojos</code> to interact with the <code>Maven</code> * This interface forms the contract required for <code>Mojos</code> to interact with the <code>Maven</code>
* infrastructure. * infrastructure.<br>
* <br/>
* It features an <code>execute()</code> method, which triggers the Mojo's build-process behavior, and can throw * It features an <code>execute()</code> method, which triggers the Mojo's build-process behavior, and can throw
* a MojoExecutionException or MojoFailureException if error conditions occur. * a MojoExecutionException or MojoFailureException if error conditions occur.<br>
* <br/>
* Also included is the <code>setLog(...)</code> method, which simply allows Maven to inject a logging mechanism which * Also included is the <code>setLog(...)</code> method, which simply allows Maven to inject a logging mechanism which
* will allow the Mojo to communicate to the outside world through standard Maven channels. * will allow the Mojo to communicate to the outside world through standard Maven channels.
* *
@ -39,8 +37,7 @@ public interface Mojo
String ROLE = Mojo.class.getName(); String ROLE = Mojo.class.getName();
/** /**
* Perform whatever build-process behavior this <code>Mojo</code> implements. * Perform whatever build-process behavior this <code>Mojo</code> implements.<br>
* <br/>
* This is the main trigger for the <code>Mojo</code> inside the <code>Maven</code> system, and allows * This is the main trigger for the <code>Mojo</code> inside the <code>Maven</code> system, and allows
* the <code>Mojo</code> to communicate errors. * the <code>Mojo</code> to communicate errors.
* *

View File

@ -20,8 +20,7 @@ package org.apache.maven.plugin;
*/ */
/** /**
* An exception occurring during the execution of a plugin. * An exception occurring during the execution of a plugin.<br>
* <br/>
* Throwing this exception causes a "BUILD ERROR" message to be displayed. * Throwing this exception causes a "BUILD ERROR" message to be displayed.
* *
* @author Brett Porter * @author Brett Porter

View File

@ -20,8 +20,7 @@ package org.apache.maven.plugin;
*/ */
/** /**
* An exception occurring during the execution of a plugin (such as a compilation failure). * An exception occurring during the execution of a plugin (such as a compilation failure).<br>
* <br/>
* Throwing this exception causes a "BUILD FAILURE" message to be displayed. * Throwing this exception causes a "BUILD FAILURE" message to be displayed.
* *
* @author Brett Porter * @author Brett Porter

View File

@ -30,8 +30,7 @@ import org.codehaus.plexus.configuration.PlexusConfiguration;
import org.codehaus.plexus.configuration.xml.XmlPlexusConfiguration; import org.codehaus.plexus.configuration.xml.XmlPlexusConfiguration;
/** /**
* The bean containing the Mojo descriptor. * The bean containing the Mojo descriptor.<br>
* <br/>
* For more information about the usage tag, have a look to: * For more information about the usage tag, have a look to:
* <a href="https://maven.apache.org/developers/mojo-api-specification.html"> * <a href="https://maven.apache.org/developers/mojo-api-specification.html">
* https://maven.apache.org/developers/mojo-api-specification.html</a> * https://maven.apache.org/developers/mojo-api-specification.html</a>

View File

@ -21,8 +21,7 @@ package org.apache.maven.plugin.logging;
/** /**
* This interface supplies the API for providing feedback to the user from the <code>Mojo</code>, using standard * This interface supplies the API for providing feedback to the user from the <code>Mojo</code>, using standard
* <code>Maven</code> channels. * <code>Maven</code> channels.<br>
* <br/>
* There should be no big surprises here, although you may notice that the methods accept * There should be no big surprises here, although you may notice that the methods accept
* <code>java.lang.CharSequence</code> rather than <code>java.lang.String</code>. This is provided mainly as a * <code>java.lang.CharSequence</code> rather than <code>java.lang.String</code>. This is provided mainly as a
* convenience, to enable developers to pass things like <code>java.lang.StringBuffer</code> directly into the logger, * convenience, to enable developers to pass things like <code>java.lang.StringBuffer</code> directly into the logger,
@ -45,8 +44,7 @@ public interface Log
void debug( CharSequence content ); void debug( CharSequence content );
/** /**
* Send a message (and accompanying exception) to the user in the <b>debug</b> error level. * Send a message (and accompanying exception) to the user in the <b>debug</b> error level.<br>
* <br/>
* The error's stacktrace will be output when this error level is enabled. * The error's stacktrace will be output when this error level is enabled.
* *
* @param content * @param content
@ -55,8 +53,7 @@ public interface Log
void debug( CharSequence content, Throwable error ); void debug( CharSequence content, Throwable error );
/** /**
* Send an exception to the user in the <b>debug</b> error level. * Send an exception to the user in the <b>debug</b> error level.<br>
* <br/>
* The stack trace for this exception will be output when this error level is enabled. * The stack trace for this exception will be output when this error level is enabled.
* *
* @param error * @param error
@ -76,8 +73,7 @@ public interface Log
void info( CharSequence content ); void info( CharSequence content );
/** /**
* Send a message (and accompanying exception) to the user in the <b>info</b> error level. * Send a message (and accompanying exception) to the user in the <b>info</b> error level.<br>
* <br/>
* The error's stacktrace will be output when this error level is enabled. * The error's stacktrace will be output when this error level is enabled.
* *
* @param content * @param content
@ -86,8 +82,7 @@ public interface Log
void info( CharSequence content, Throwable error ); void info( CharSequence content, Throwable error );
/** /**
* Send an exception to the user in the <b>info</b> error level. * Send an exception to the user in the <b>info</b> error level.<br>
* <br/>
* The stack trace for this exception will be output when this error level is enabled. * The stack trace for this exception will be output when this error level is enabled.
* *
* @param error * @param error
@ -107,8 +102,7 @@ public interface Log
void warn( CharSequence content ); void warn( CharSequence content );
/** /**
* Send a message (and accompanying exception) to the user in the <b>warn</b> error level. * Send a message (and accompanying exception) to the user in the <b>warn</b> error level.<br>
* <br/>
* The error's stacktrace will be output when this error level is enabled. * The error's stacktrace will be output when this error level is enabled.
* *
* @param content * @param content
@ -117,8 +111,7 @@ public interface Log
void warn( CharSequence content, Throwable error ); void warn( CharSequence content, Throwable error );
/** /**
* Send an exception to the user in the <b>warn</b> error level. * Send an exception to the user in the <b>warn</b> error level.<br>
* <br/>
* The stack trace for this exception will be output when this error level is enabled. * The stack trace for this exception will be output when this error level is enabled.
* *
* @param error * @param error
@ -138,8 +131,7 @@ public interface Log
void error( CharSequence content ); void error( CharSequence content );
/** /**
* Send a message (and accompanying exception) to the user in the <b>error</b> error level. * Send a message (and accompanying exception) to the user in the <b>error</b> error level.<br>
* <br/>
* The error's stacktrace will be output when this error level is enabled. * The error's stacktrace will be output when this error level is enabled.
* *
* @param content * @param content
@ -148,8 +140,7 @@ public interface Log
void error( CharSequence content, Throwable error ); void error( CharSequence content, Throwable error );
/** /**
* Send an exception to the user in the <b>error</b> error level. * Send an exception to the user in the <b>error</b> error level.<br>
* <br/>
* The stack trace for this exception will be output when this error level is enabled. * The stack trace for this exception will be output when this error level is enabled.
* *
* @param error * @param error

View File

@ -46,8 +46,8 @@ import org.eclipse.aether.resolution.ArtifactDescriptorResult;
/** /**
* Populates Aether {@link ArtifactDescriptorResult} from Maven project {@link Model}. * Populates Aether {@link ArtifactDescriptorResult} from Maven project {@link Model}.
* *
* <strong>Note:</strong> This class is part of work in progress and can be changed or removed without notice.
* @since 3.2.4 * @since 3.2.4
* @provisional This class is part of work in progress and can be changed or removed without notice.
*/ */
public class ArtifactDescriptorReaderDelegate public class ArtifactDescriptorReaderDelegate
{ {

View File

@ -120,7 +120,7 @@
<required>true</required> <required>true</required>
<description> <description>
<![CDATA[ <![CDATA[
The local repository.<br /><b>Default value is:</b> <tt>${user.home}/.m2/repository</tt> The local repository.<br><b>Default value is:</b> <tt>${user.home}/.m2/repository</tt>
]]> ]]>
</description> </description>
<type>String</type> <type>String</type>

View File

@ -63,7 +63,7 @@ under the License.
<wagonVersion>2.12</wagonVersion> <wagonVersion>2.12</wagonVersion>
<securityDispatcherVersion>1.4</securityDispatcherVersion> <securityDispatcherVersion>1.4</securityDispatcherVersion>
<cipherVersion>1.7</cipherVersion> <cipherVersion>1.7</cipherVersion>
<modelloVersion>1.8.3</modelloVersion> <modelloVersion>1.9.0</modelloVersion>
<jxpathVersion>1.3</jxpathVersion> <jxpathVersion>1.3</jxpathVersion>
<resolverVersion>1.0.3</resolverVersion> <resolverVersion>1.0.3</resolverVersion>
<slf4jVersion>1.7.22</slf4jVersion> <slf4jVersion>1.7.22</slf4jVersion>