Switch version to 4.0.0 for @since tags (#1068)

This commit is contained in:
Guillaume Nodet 2023-03-23 06:29:39 +01:00 committed by GitHub
parent cadeab53f6
commit 2788849c37
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
99 changed files with 100 additions and 100 deletions

View File

@ -25,7 +25,7 @@
/**
* An artifact points to a resource such as a jar file or war application.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Immutable

View File

@ -26,7 +26,7 @@
* The {@code Coordinate} object is used to point to an {@link Artifact}
* but the version may be specified as a range instead of an exact version.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Immutable

View File

@ -27,7 +27,7 @@
/**
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Immutable

View File

@ -28,7 +28,7 @@
* Such events can be listened to using {@link Listener}s objects
* registered in the {@link Session}.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface Event {

View File

@ -23,7 +23,7 @@
/**
* The possible types of execution events.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public enum EventType {

View File

@ -24,7 +24,7 @@
/**
* A dependency exlusion.
*
* @since 4.0
* @since 4.0.0
* @see DependencyCoordinate#getExclusions()
*/
@Experimental

View File

@ -23,7 +23,7 @@
/**
* A specific {@link Toolchain} dedicated for Java.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface JavaToolchain extends Toolchain {

View File

@ -26,7 +26,7 @@
* A listener for session events.
* TODO: open this to other events like similar to {@code org.apache.maven.eventspy.EventSpy}
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@FunctionalInterface

View File

@ -28,7 +28,7 @@
* The local repository is used to cache artifacts downloaded from {@link RemoteRepository}
* and to hold artifacts that have been build locally.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Immutable

View File

@ -23,7 +23,7 @@
/**
* Storage location for metadata
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public enum MetadataStorage {

View File

@ -30,7 +30,7 @@
/**
* Represents a dependency node within a Maven project's dependency collector.
*
* @since 4.0
* @since 4.0.0
* @see org.apache.maven.api.services.DependencyCollectorResult#getRoot()
*/
@Experimental

View File

@ -25,7 +25,7 @@
/**
* Defines a hierarchical visitor for collecting dependency node trees.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Consumer

View File

@ -31,7 +31,7 @@
* Interface representing a Maven project.
* Projects can be built using the {@link org.apache.maven.api.services.ProjectBuilder} service.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface Project {

View File

@ -25,7 +25,7 @@
/**
* A repository holds artifacts.
*
* @since 4.0
* @since 4.0.0
* @see RemoteRepository
* @see LocalRepository
*/

View File

@ -36,7 +36,7 @@
* Important note: The {@code id} values of this enum correspond to constants of
* {@code org.apache.maven.artifact.Artifact} class and MUST BE KEPT IN SYNC.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public enum ResolutionScope {

View File

@ -25,7 +25,7 @@
/**
* Scope for a dependency
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public enum Scope {

View File

@ -36,7 +36,7 @@
/**
* The session to install / deploy / resolve artifacts and dependencies.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@ThreadSafe

View File

@ -36,7 +36,7 @@
* <strong>Note:</strong> Actual implementations must be thread-safe.
*
* @see Session#getData()
* @since 4.0
* @since 4.0.0
*/
@Experimental
@ThreadSafe

View File

@ -25,7 +25,7 @@
/**
* Toolchain interface.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface Toolchain {

View File

@ -29,7 +29,7 @@
* It is also used to determine if a given dependency should be
* included in the classpath or if its transitive dependencies should.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Immutable

View File

@ -24,7 +24,7 @@
/**
* A version usually parsed using the {@link org.apache.maven.api.services.VersionParser} service.
*
* @since 4.0
* @since 4.0.0
* @see org.apache.maven.api.services.VersionParser#parseVersion(String)
* @see org.apache.maven.api.Session#parseVersion(String)
*/

View File

@ -24,7 +24,7 @@
/**
* A range of versions.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface VersionRange {

View File

@ -28,7 +28,7 @@
* convenience, to enable developers to pass things like <code>java.lang.StringBuffer</code> directly into the logger,
* rather than formatting first by calling <code>toString()</code>.
*
* @since 4.0
* @since 4.0.0
*/
public interface Log {
/**

View File

@ -27,7 +27,7 @@
* It features an <code>execute()</code> method, which triggers the Mojo's build-process behavior, and can throw
* a MojoException if error conditions occur.<br>
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@FunctionalInterface

View File

@ -24,7 +24,7 @@
/**
* An exception occurring during the execution of a plugin.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public class MojoException extends MavenException {

View File

@ -32,7 +32,7 @@
* <a href="/ref/current/maven-core/apidocs/org/apache/maven/plugin/MavenPluginManager.html">
* <code>MavenPluginManager.getConfiguredMojo(...)</code></a>.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Documented

View File

@ -30,7 +30,7 @@
/**
* Used if your Mojo needs to fork a <a href="/ref/3.0.4/maven-core/lifecycles.html">lifecycle</a>.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Documented

View File

@ -23,7 +23,7 @@
/**
* Component instantiation strategy.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public enum InstantiationStrategy {

View File

@ -23,7 +23,7 @@
/**
* <a href="/ref/3.0.4/maven-core/lifecycles.html">Lifecycle phases</a>.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public enum LifecyclePhase {

View File

@ -31,7 +31,7 @@
/**
* This annotation will mark your class as a Mojo (ie. goal in a Maven plugin).
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Documented

View File

@ -36,7 +36,7 @@
* container: this annotation is only effective on fields of the Mojo class itself, nested bean injection
* requires Sisu or JSR330 annotations.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Documented

View File

@ -28,7 +28,7 @@
/**
* Service used to create {@link ArtifactCoordinate} objects.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface ArtifactCoordinateFactory extends Service {

View File

@ -30,7 +30,7 @@
/**
* A request for creating a {@link ArtifactCoordinate} object.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Immutable

View File

@ -30,7 +30,7 @@
/**
* Deploys {@link Artifact}s to a {@link RemoteRepository}.
*
* @since 4.0
* @since 4.0.0
* @see Session#deployArtifact(RemoteRepository, Artifact...)
*/
@Experimental

View File

@ -23,7 +23,7 @@
/**
* An artifact could not correctly being deployed.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public class ArtifactDeployerException extends MavenException {

View File

@ -32,7 +32,7 @@
/**
* A request for deploying one or more artifacts to a remote repository.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Immutable

View File

@ -27,7 +27,7 @@
/**
* Service used to create {@link Artifact} objects.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface ArtifactFactory extends Service {

View File

@ -29,7 +29,7 @@
/**
*
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Immutable

View File

@ -29,7 +29,7 @@
/**
* Installs {@link Artifact}s to the local repository.
*
* @since 4.0
* @since 4.0.0
* @see Session#withLocalRepository(org.apache.maven.api.LocalRepository)
*/
@Experimental

View File

@ -21,7 +21,7 @@
import org.apache.maven.api.annotations.Experimental;
/**
* @since 4.0
* @since 4.0.0
*/
@Experimental
public class ArtifactInstallerException extends MavenException {

View File

@ -34,7 +34,7 @@
/**
* A request for installing one or more artifacts in the local repository.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Immutable

View File

@ -28,7 +28,7 @@
/**
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface ArtifactManager extends Service {

View File

@ -28,7 +28,7 @@
/**
* Resolves the artifact, i.e download the file when required and attach it to the artifact
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface ArtifactResolver extends Service {

View File

@ -23,7 +23,7 @@
/**
*
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public class ArtifactResolverException extends MavenException {

View File

@ -32,7 +32,7 @@
/**
* A request for resolving an artifact.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Immutable

View File

@ -28,7 +28,7 @@
/**
* The Artifact Result
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface ArtifactResolverResult {

View File

@ -29,7 +29,7 @@
/**
* Base class for requests.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
abstract class BaseRequest {

View File

@ -27,7 +27,7 @@
* Describes a problem that was encountered during project building. A problem can either be an exception that was
* thrown or a simple string message. In addition, a problem carries a hint about its source.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Immutable
@ -97,7 +97,7 @@ public interface BuilderProblem {
/**
* The different severity levels for a problem, in decreasing order.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
enum Severity {

View File

@ -32,7 +32,7 @@
* The dependencies collection mechanism will not download any artifacts,
* and only the pom files will be downloaded.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface DependencyCollector extends Service {

View File

@ -24,7 +24,7 @@
* Thrown in case of bad artifact descriptors, version ranges or other
* issues encountered during calculation of the dependency graph.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public class DependencyCollectorException extends MavenException {

View File

@ -43,7 +43,7 @@
* retrieved from the artifact descriptor of the root dependency. And last, only direct dependencies can be specified in
* which case the root node of the resulting graph has no associated dependency.
*
* @since 4.0
* @since 4.0.0
* @see DependencyCollector#collect(DependencyCollectorRequest)
*/
@Experimental

View File

@ -26,7 +26,7 @@
/**
* The result of a dependency collection request.
*
* @since 4.0
* @since 4.0.0
* @see DependencyCollector#collect(DependencyCollectorRequest)
*/
@Experimental

View File

@ -30,7 +30,7 @@
/**
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface DependencyCoordinateFactory extends Service {

View File

@ -35,7 +35,7 @@
/**
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Immutable

View File

@ -29,7 +29,7 @@
/**
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface LocalRepositoryManager extends Service {

View File

@ -23,7 +23,7 @@
/**
* The Exception class throw by the {@link Lookup} service.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public class LookupException extends MavenException {

View File

@ -23,7 +23,7 @@
/**
* Base class for all maven exceptions.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public class MavenException extends RuntimeException {

View File

@ -23,7 +23,7 @@
/**
* Message builder that supports configurable styling.
*
* @since 4.0
* @since 4.0.0
* @see MessageBuilderFactory
*/
public interface MessageBuilder {

View File

@ -25,7 +25,7 @@
/**
* A factory for {@link MessageBuilder}.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface MessageBuilderFactory extends Service {

View File

@ -28,7 +28,7 @@
import org.apache.maven.api.annotations.Nonnull;
/**
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface ProjectBuilder extends Service {

View File

@ -23,7 +23,7 @@
/**
* The Exception class throw by the {@link ProjectBuilder} service.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public class ProjectBuilderException extends MavenException {

View File

@ -36,7 +36,7 @@
* Request used to build a {@link org.apache.maven.api.Project} using
* the {@link ProjectBuilder} service.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Immutable

View File

@ -29,7 +29,7 @@
/**
* Result of a project build call.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface ProjectBuilderResult {

View File

@ -36,7 +36,7 @@
/**
* Interface to manage the project during its lifecycle.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface ProjectManager extends Service {

View File

@ -26,7 +26,7 @@
/**
* Service used to interact with the end user.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface Prompter extends Service {

View File

@ -23,7 +23,7 @@
/**
* The Exception class throw by the {@link Prompter} service.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public class PrompterException extends MavenException {

View File

@ -30,7 +30,7 @@
/**
* Factory service to create {@link LocalRepository} or {@link RemoteRepository} objects.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface RepositoryFactory extends Service {

View File

@ -23,7 +23,7 @@
/**
* The Exception class throw by the {@link SettingsBuilder}.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public class SettingsBuilderException extends MavenException {

View File

@ -26,7 +26,7 @@
/**
* The source for a project's XML model.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface Source {

View File

@ -22,7 +22,7 @@
import org.apache.maven.api.annotations.Experimental;
/**
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Consumer

View File

@ -31,7 +31,7 @@
/**
* Service to manage {@link Toolchain}s.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface ToolchainManager extends Service {

View File

@ -23,7 +23,7 @@
/**
* The Exception class throw by the {@link ToolchainManager}.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public class ToolchainManagerException extends MavenException {

View File

@ -23,7 +23,7 @@
/**
* The Exception class throw by the {@link ToolchainsBuilder}.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public class ToolchainsBuilderException extends MavenException {

View File

@ -34,7 +34,7 @@
* Transport for specified remote repository (using provided remote repository base URI as root). Must be treated as a
* resource, best in try-with-resource block.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Consumer

View File

@ -34,7 +34,7 @@
* This implementation is backed by Maven Resolver API, supported protocols and transport selection depends on it. If
* resolver preference regarding transport is altered, it will affect this service as well.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Consumer

View File

@ -22,7 +22,7 @@
import org.apache.maven.api.annotations.Experimental;
/**
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Consumer

View File

@ -26,7 +26,7 @@
/**
* Access to {@link Type} registry.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface TypeRegistry extends Service {

View File

@ -27,7 +27,7 @@
/**
* Service interface to parse {@link Version} and {@link VersionRange}.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface VersionParser extends Service {

View File

@ -23,7 +23,7 @@
/**
* The Exception class thrown by {@link VersionParser}.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public class VersionParserException extends MavenException {

View File

@ -24,7 +24,7 @@
/**
* Reads or writes a {@link Model} using XML.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface ModelXmlFactory extends XmlFactory<Model> {}

View File

@ -24,7 +24,7 @@
/**
* Reads and writes a {@link Settings} object to/from XML.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface SettingsXmlFactory extends XmlFactory<Settings> {}

View File

@ -24,7 +24,7 @@
/**
* Reads and writes a {@link PersistedToolchains} object to/from XML.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface ToolchainsXmlFactory extends XmlFactory<PersistedToolchains> {}

View File

@ -34,7 +34,7 @@
* Generic interface to read/write objects to/from XML.
*
* @param <T> the object type to read/write
* @since 4.0
* @since 4.0.0
*/
@Experimental
public interface XmlFactory<T> extends Service {

View File

@ -24,7 +24,7 @@
/**
* An exception thrown during the reading of an xml file.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public class XmlReaderException extends MavenException {

View File

@ -31,7 +31,7 @@
/**
* An XML reader request.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Immutable

View File

@ -24,7 +24,7 @@
/**
* An exception thrown during the writing of an xml file.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
public class XmlWriterException extends MavenException {

View File

@ -27,7 +27,7 @@
/**
* An XML writer request.
*
* @since 4.0
* @since 4.0.0
* @param <T> the object type to read
*/
@Experimental

View File

@ -35,7 +35,7 @@
* to be a provider type regardless of whether they are marked {@link Consumer} or {@link Provider}.
*
* @see Provider
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Documented

View File

@ -26,7 +26,7 @@
* This annotation tags types that are part of an experimental API.
* Classes or methods annotated with this annotation may be changed / removed without notice.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Documented

View File

@ -27,7 +27,7 @@
/**
* This annotation indicates that a type is automatically generated.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Documented

View File

@ -30,7 +30,7 @@
* {@link ThreadSafe}.
*
* @see ThreadSafe
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Documented

View File

@ -32,7 +32,7 @@
* When this annotation is applied to a method it applies to the method return value.
*
* @see Nullable
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Documented

View File

@ -29,7 +29,7 @@
* and should only be used by a single thread.
*
* @see ThreadSafe
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Documented

View File

@ -26,7 +26,7 @@
* The annotated element can be {@code null}.
*
* @see Nonnull
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Documented

View File

@ -35,7 +35,7 @@
* to be a provider type regardless of whether they are marked {@link Consumer} or {@link Provider}.
*
* @see Consumer
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Documented

View File

@ -30,7 +30,7 @@
*
* @see Immutable
* @see NotThreadSafe
* @since 4.0
* @since 4.0.0
*/
@Experimental
@Documented

View File

@ -4,7 +4,7 @@
* used to tag various elements and help users understanding
* how those types should be used.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
package org.apache.maven.api.annotations;

View File

@ -30,7 +30,7 @@
/**
* An immutable xml node.
*
* @since 4.0
* @since 4.0.0
*/
@Experimental
@ThreadSafe

View File

@ -31,7 +31,7 @@ public interface ProfileActivationContext {
/**
* Key of the property containing the project's packaging.
* Available in {@link #getUserProperties()}.
* @since 4.0
* @since 4.0.0
*/
String PROPERTY_NAME_PACKAGING = "packaging";