Apache
/
maven
mirror of https://github.com/apache/maven.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Missing annotations on api (#1428)

This commit is contained in:
Guillaume Nodet 2024-02-29 00:54:53 +01:00 committed by GitHub
parent 24eee1f8e6
commit 456890d40b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
31 changed files with 183 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
api/maven-api-core/src/main/java/org/apache/maven/api/Dependency.java
View File

@ -18,8 +18,16 @@
*/
package org.apache.maven.api;
import org.apache.maven.api.annotations.Experimental;
import org.apache.maven.api.annotations.Immutable;
import org.apache.maven.api.annotations.Nonnull;
/**
*
* @since 4.0.0
*/
@Experimental
@Immutable
public interface Dependency extends Artifact {
/**

4
api/maven-api-core/src/main/java/org/apache/maven/api/ExtensibleEnum.java
View File

@ -18,12 +18,16 @@
*/
package org.apache.maven.api;
import org.apache.maven.api.annotations.Experimental;
import org.apache.maven.api.annotations.Nonnull;
/**
* Implementation must have {@code equals()} and {@code hashCode()} implemented, so implementations of this interface
* can be used as keys.
*
* @since 4.0.0
*/
@Experimental
public interface ExtensibleEnum {
/**

2
api/maven-api-core/src/main/java/org/apache/maven/api/MojoExecution.java
View File

@ -31,6 +31,8 @@ import org.apache.maven.api.xml.XmlNode;
* An instance of this object is bound to the {@link org.apache.maven.api.di.MojoExecutionScoped}
* and available as {@code mojoExecution} within {@link org.apache.maven.api.plugin.annotations.Parameter}
* expressions.
*
* @since 4.0.0
*/
@Experimental
public interface MojoExecution {

2
api/maven-api-core/src/main/java/org/apache/maven/api/Plugin.java
View File

@ -29,6 +29,8 @@ import org.apache.maven.api.plugin.descriptor.lifecycle.Lifecycle;
/**
* Represents a maven plugin runtime
*
* @since 4.0.0
*/
@Experimental
public interface Plugin {

2
api/maven-api-core/src/main/java/org/apache/maven/api/RemoteRepository.java
View File

@ -24,6 +24,8 @@ import org.apache.maven.api.annotations.Nonnull;
/**
* A remote repository that can be used to download or upload artifacts.
*
* @since 4.0.0
*/
@Experimental
@Immutable

1
api/maven-api-core/src/main/java/org/apache/maven/api/Service.java
View File

@ -27,6 +27,7 @@ import org.apache.maven.api.annotations.ThreadSafe;
* Services can be retrieved from the session using the
* {@link Session#getService(Class)} method.
*
* @since 4.0.0
* @see Session#getService(Class)
*/
@Experimental

58
api/maven-api-core/src/main/java/org/apache/maven/api/Session.java
View File

@ -502,15 +502,63 @@ public interface Session {
@Nonnull
VersionConstraint parseVersionConstraint(@Nonnull String versionConstraint);
Type requireType(String id);
/**
* Obtain the {@link Type} from the specified {@code id}.
* <p>
* Shortcut for {@code getService(TypeRegistry.class).require(...)}.
*
* @see org.apache.maven.api.services.TypeRegistry#require(String)
*/
@Nonnull
Type requireType(@Nonnull String id);
Language requireLanguage(String id);
/**
* Obtain the {@link Language} from the specified {@code id}.
* <p>
* Shortcut for {@code getService(LanguageRegistry.class).require(...)}.
*
* @see org.apache.maven.api.services.LanguageRegistry#require(String)
*/
@Nonnull
Language requireLanguage(@Nonnull String id);
Packaging requirePackaging(String id);
/**
* Obtain the {@link Packaging} from the specified {@code id}.
* <p>
* Shortcut for {@code getService(PackagingRegistry.class).require(...)}.
*
* @see org.apache.maven.api.services.PackagingRegistry#require(String)
*/
@Nonnull
Packaging requirePackaging(@Nonnull String id);
ProjectScope requireProjectScope(String id);
/**
* Obtain the {@link ProjectScope} from the specified {@code id}.
* <p>
* Shortcut for {@code getService(ProjectScopeRegistry.class).require(...)}.
*
* @see org.apache.maven.api.services.ProjectScopeRegistry#require(String)
*/
@Nonnull
ProjectScope requireProjectScope(@Nonnull String id);
/**
* Obtain the {@link DependencyScope} from the specified {@code id}.
* <p>
* Shortcut for {@code DependencyScope.forId(...)}.
*
* @see org.apache.maven.api.DependencyScope#forId(String)
*/
@Nonnull
DependencyScope requireDependencyScope(@Nonnull String id);
PathScope requirePathScope(String id);
/**
* Obtain the {@link PathScope} from the specified {@code id}.
* <p>
* Shortcut for {@code getService(PathScopeRegistry.class).require(...)}.
*
* @see org.apache.maven.api.services.PathScopeRegistry#require(String)
*/
@Nonnull
PathScope requirePathScope(@Nonnull String id);
}

2
api/maven-api-core/src/main/java/org/apache/maven/api/plugin/LifecycleProvider.java
View File

@ -30,6 +30,8 @@ import org.apache.maven.api.plugin.descriptor.lifecycle.Lifecycle;
* annotation. If a {@code META-INF/maven/lifecycle.xml} file is packaged
* in the plugin, Maven will provide a default implementation that will parse
* the file and return the contained lifecycle definitions.
*
* @since 4.0.0
*/
@Experimental
@Consumer

2
api/maven-api-core/src/main/java/org/apache/maven/api/plugin/Log.java
View File

@ -20,6 +20,7 @@ package org.apache.maven.api.plugin;
import java.util.function.Supplier;
import org.apache.maven.api.annotations.Experimental;
import org.apache.maven.api.annotations.Provider;
/**
@ -32,6 +33,7 @@ import org.apache.maven.api.annotations.Provider;
*
* @since 4.0.0
*/
@Experimental
@Provider
public interface Log {
/**

5
api/maven-api-core/src/main/java/org/apache/maven/api/services/ExtensibleEnumRegistry.java
View File

@ -26,9 +26,10 @@ import org.apache.maven.api.annotations.Nonnull;
public interface ExtensibleEnumRegistry<T extends ExtensibleEnum> extends Service {
@Nonnull
Optional<T> lookup(String id);
Optional<T> lookup(@Nonnull String id);
default T require(String id) {
@Nonnull
default T require(@Nonnull String id) {
return lookup(id).orElseThrow(() -> new IllegalArgumentException("Unknown extensible enum value '" + id + "'"));
}
}

4
api/maven-api-core/src/main/java/org/apache/maven/api/services/ProjectScopeRegistry.java
View File

@ -19,8 +19,12 @@
package org.apache.maven.api.services;
import org.apache.maven.api.ProjectScope;
import org.apache.maven.api.annotations.Experimental;
/**
* Manager for {@link ProjectScope}.
*
* @since 4.0.0
*/
@Experimental
public interface ProjectScopeRegistry extends ExtensibleEnumRegistry<ProjectScope> {}

4
api/maven-api-core/src/main/java/org/apache/maven/api/services/SettingsBuilder.java
View File

@ -22,11 +22,15 @@ import java.nio.file.Path;
import org.apache.maven.api.Service;
import org.apache.maven.api.Session;
import org.apache.maven.api.annotations.Experimental;
import org.apache.maven.api.annotations.Nonnull;
/**
* Builds the effective settings from a user settings file and/or a global settings file.
*
* @since 4.0.0
*/
@Experimental
public interface SettingsBuilder extends Service {
/**

6
api/maven-api-core/src/main/java/org/apache/maven/api/services/SettingsBuilderResult.java
View File

@ -20,9 +20,15 @@ package org.apache.maven.api.services;
import java.util.List;
import org.apache.maven.api.annotations.Experimental;
import org.apache.maven.api.annotations.Nonnull;
import org.apache.maven.api.settings.Settings;
/**
*
* @since 4.0.0
*/
@Experimental
public interface SettingsBuilderResult {
/**

2
api/maven-api-core/src/main/java/org/apache/maven/api/services/SuperPomProvider.java
View File

@ -25,6 +25,8 @@ import org.apache.maven.api.model.Model;
/**
* Provides the super POM that all models implicitly inherit from.
*
* @since 4.0.0
*/
@Experimental
public interface SuperPomProvider extends Service {

2
api/maven-api-core/src/main/java/org/apache/maven/api/services/ToolchainsBuilder.java
View File

@ -25,6 +25,8 @@ import org.apache.maven.api.annotations.Nonnull;
/**
* Builds the effective toolchains from a user toolchains file and/or a global toolchains file.
*
* @since 4.0.0
*/
@Experimental
public interface ToolchainsBuilder extends Service {

6
api/maven-api-core/src/main/java/org/apache/maven/api/services/ToolchainsBuilderRequest.java
View File

@ -22,12 +22,18 @@ import java.nio.file.Path;
import java.util.Optional;
import org.apache.maven.api.Session;
import org.apache.maven.api.annotations.Experimental;
import org.apache.maven.api.annotations.Nonnull;
import org.apache.maven.api.annotations.NotThreadSafe;
import org.apache.maven.api.annotations.Nullable;
import static org.apache.maven.api.services.BaseRequest.nonNull;
/**
*
* @since 4.0.0
*/
@Experimental
public interface ToolchainsBuilderRequest {
@Nonnull
Session getSession();

6
api/maven-api-core/src/main/java/org/apache/maven/api/services/ToolchainsBuilderResult.java
View File

@ -20,9 +20,15 @@ package org.apache.maven.api.services;
import java.util.List;
import org.apache.maven.api.annotations.Experimental;
import org.apache.maven.api.annotations.Nonnull;
import org.apache.maven.api.toolchain.PersistedToolchains;
/**
*
* @since 4.0.0
*/
@Experimental
public interface ToolchainsBuilderResult {
/**
* Gets the assembled toolchains.

2
api/maven-api-core/src/main/java/org/apache/maven/api/services/VersionRangeResolver.java
View File

@ -27,6 +27,8 @@ import org.apache.maven.api.annotations.Nonnull;
/**
* Parses and evaluates version ranges encountered in dependency declarations.
*
* @since 4.0.0
*/
@Experimental
@Consumer

4
api/maven-api-core/src/main/java/org/apache/maven/api/services/VersionRangeResolverRequest.java
View File

@ -26,6 +26,10 @@ import org.apache.maven.api.annotations.NotThreadSafe;
import static org.apache.maven.api.services.BaseRequest.nonNull;
/**
*
* @since 4.0.0
*/
@Experimental
public interface VersionRangeResolverRequest {

4
api/maven-api-core/src/main/java/org/apache/maven/api/services/VersionRangeResolverResult.java
View File

@ -26,6 +26,10 @@ import org.apache.maven.api.Version;
import org.apache.maven.api.annotations.Experimental;
import org.apache.maven.api.annotations.Nonnull;
/**
*
* @since 4.0.0
*/
@Experimental
public interface VersionRangeResolverResult {

2
api/maven-api-core/src/main/java/org/apache/maven/api/services/VersionResolver.java
View File

@ -27,6 +27,8 @@ import org.apache.maven.api.annotations.Nonnull;
/**
* Resolves artifact meta/pseudo versions.
*
* @since 4.0.0
*/
@Experimental
@Consumer

4
api/maven-api-core/src/main/java/org/apache/maven/api/services/VersionResolverRequest.java
View File

@ -26,6 +26,10 @@ import org.apache.maven.api.annotations.NotThreadSafe;
import static org.apache.maven.api.services.BaseRequest.nonNull;
/**
*
* @since 4.0.0
*/
@Experimental
public interface VersionResolverRequest {

4
api/maven-api-core/src/main/java/org/apache/maven/api/services/VersionResolverResult.java
View File

@ -26,6 +26,10 @@ import org.apache.maven.api.Version;
import org.apache.maven.api.annotations.Experimental;
import org.apache.maven.api.annotations.Nonnull;
/**
*
* @since 4.0.0
*/
@Experimental
public interface VersionResolverResult {

2
api/maven-api-meta/src/main/java/org/apache/maven/api/annotations/Consumer.java
View File

@ -31,7 +31,7 @@ import java.lang.annotation.Target;
* A type can be marked {@link Consumer} or {@link Provider} but not both. A type is assumed to be
* {@link Consumer} if it is not marked either {@link Consumer} or {@link Provider}.
* <p>
* A package can be marked {@link Provider}. In this case, all types in the package are considered
* A package can be marked {@link Consumer}. In this case, all types in the package are considered
* to be a provider type regardless of whether they are marked {@link Consumer} or {@link Provider}.
*
* @see Provider

16
api/maven-api-spi/src/main/java/org/apache/maven/api/spi/ExtensibleEnumProvider.java
View File

@ -21,8 +21,24 @@ package org.apache.maven.api.spi;
import java.util.Collection;
import org.apache.maven.api.ExtensibleEnum;
import org.apache.maven.api.annotations.Consumer;
import org.apache.maven.api.annotations.Experimental;
import org.apache.maven.api.annotations.Nonnull;
/**
* An SPI interface to extend Maven with a new enum value.
*
* @param <T> The type of extensible enum to extend
*/
@Experimental
@Consumer
public interface ExtensibleEnumProvider<T extends ExtensibleEnum> extends SpiService {
/**
* Registers new values for the T extensible enum.
*
* @return a collection of T instances to register
*/
@Nonnull
Collection<T> provides();
}

7
api/maven-api-spi/src/main/java/org/apache/maven/api/spi/LanguageProvider.java
View File

@ -19,5 +19,12 @@
package org.apache.maven.api.spi;
import org.apache.maven.api.Language;
import org.apache.maven.api.annotations.Consumer;
import org.apache.maven.api.annotations.Experimental;
/**
* @since 4.0.0
*/
@Experimental
@Consumer
public interface LanguageProvider extends ExtensibleEnumProvider<Language> {}

5
api/maven-api-spi/src/main/java/org/apache/maven/api/spi/ModelParser.java
View File

@ -22,6 +22,7 @@ import java.nio.file.Path;
import java.util.Map;
import java.util.Optional;
import org.apache.maven.api.annotations.Consumer;
import org.apache.maven.api.annotations.Experimental;
import org.apache.maven.api.annotations.Nonnull;
import org.apache.maven.api.annotations.Nullable;
@ -31,8 +32,11 @@ import org.apache.maven.api.services.Source;
/**
* The {@code ModelParser} interface is used to locate and read {@link Model}s from the file system.
* This allows plugging in additional syntaxes for the main model read by Maven when building a project.
*
* @since 4.0.0
*/
@Experimental
@Consumer
public interface ModelParser extends SpiService {
/**
@ -64,6 +68,7 @@ public interface ModelParser extends SpiService {
* @return an optional parsed {@link Model} or {@code null} if none could be found
* @throws ModelParserException if the located model cannot be parsed
*/
@Nonnull
default Optional<Model> locateAndParse(@Nonnull Path dir, @Nullable Map<String, ?> options)
throws ModelParserException {
return locate(dir).map(s -> parse(s, options));

7
api/maven-api-spi/src/main/java/org/apache/maven/api/spi/PathScopeProvider.java
View File

@ -19,5 +19,12 @@
package org.apache.maven.api.spi;
import org.apache.maven.api.PathScope;
import org.apache.maven.api.annotations.Consumer;
import org.apache.maven.api.annotations.Experimental;
/**
* @since 4.0.0
*/
@Experimental
@Consumer
public interface PathScopeProvider extends ExtensibleEnumProvider<PathScope> {}

7
api/maven-api-spi/src/main/java/org/apache/maven/api/spi/ProjectScopeProvider.java
View File

@ -19,5 +19,12 @@
package org.apache.maven.api.spi;
import org.apache.maven.api.ProjectScope;
import org.apache.maven.api.annotations.Consumer;
import org.apache.maven.api.annotations.Experimental;
/**
* @since 4.0.0
*/
@Experimental
@Consumer
public interface ProjectScopeProvider extends ExtensibleEnumProvider<ProjectScope> {}

4
api/maven-api-spi/src/main/java/org/apache/maven/api/spi/PropertyContributor.java
View File

@ -20,13 +20,17 @@ package org.apache.maven.api.spi;
import java.util.Map;
import org.apache.maven.api.annotations.Consumer;
import org.apache.maven.api.annotations.Experimental;
/**
* Component able to contribute to Maven session user properties. This SPI component is invoked
* very early, while there is no session created yet.
*
* @since 4.0.0
*/
@Experimental
@Consumer
public interface PropertyContributor extends SpiService {
/**
* Invoked just before session is created with a mutable map that carries collected user properties so far.

7
api/maven-api-spi/src/main/java/org/apache/maven/api/spi/TypeProvider.java
View File

@ -19,5 +19,12 @@
package org.apache.maven.api.spi;
import org.apache.maven.api.Type;
import org.apache.maven.api.annotations.Consumer;
import org.apache.maven.api.annotations.Experimental;
/**
* @since 4.0.0
*/
@Experimental
@Consumer
public interface TypeProvider extends ExtensibleEnumProvider<Type> {}