gnodet commented on code in PR #13011: URL: https://github.com/apache/maven/pull/13011#discussion_r3928488704
########## api/maven-api-core/src/main/java/org/apache/maven/api/RepositoryListener.java: ########## @@ -0,0 +1,73 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.maven.api; + +import org.apache.maven.api.annotations.Consumer; +import org.apache.maven.api.annotations.Experimental; +import org.apache.maven.api.annotations.Nonnull; + +/** + * Receives repository events emitted while resolving, installing, and deploying artifacts and metadata. + * Implementations must be thread-safe because callbacks may occur concurrently. + * Runtime exceptions thrown by a listener do not stop repository processing or notification of other listeners. + * + * @since 4.1.0 + */ +@Experimental +@Consumer +public interface RepositoryListener { + + default void artifactDescriptorInvalid(@Nonnull RepositoryEvent event) {} + Review Comment: All 19 callback methods lack Javadoc. For a `@Consumer` public API, each method should describe when it fires and what the event contains. For example: ```java /** * Called when an artifact descriptor could not be parsed. * * @param event the event details; {@link RepositoryEvent#getArtifact()} identifies the artifact, * {@link RepositoryEvent#getException()} describes the parse failure */ default void artifactDescriptorInvalid(@Nonnull RepositoryEvent event) {} ``` Without this, consumers must reverse-engineer semantics from Resolver documentation. ########## api/maven-api-core/src/main/java/org/apache/maven/api/RepositoryMetadata.java: ########## @@ -0,0 +1,64 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.maven.api; + +import java.nio.file.Path; +import java.util.Map; +import java.util.Optional; + +import org.apache.maven.api.annotations.Experimental; +import org.apache.maven.api.annotations.Immutable; +import org.apache.maven.api.annotations.Nonnull; + +/** + * Metadata involved in a repository event. + * + * @since 4.1.0 + */ +@Experimental +@Immutable +public interface RepositoryMetadata { + + enum Nature { + RELEASE, + SNAPSHOT, + RELEASE_OR_SNAPSHOT, + } + + @Nonnull + String getGroupId(); + + @Nonnull + String getArtifactId(); + + @Nonnull Review Comment: All getter methods lack Javadoc. At minimum, `getType()` needs clarification — it returns the metadata filename (e.g., `"maven-metadata.xml"`), not a MIME type or content descriptor. `getNature()` should explain the RELEASE/SNAPSHOT/RELEASE_OR_SNAPSHOT semantics. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
