[ 
https://issues.apache.org/jira/browse/MNG-8023?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17808729#comment-17808729
 ] 

ASF GitHub Bot commented on MNG-8023:
-------------------------------------

michael-o commented on code in PR #1387:
URL: https://github.com/apache/maven/pull/1387#discussion_r1459295343


##########
api/maven-api-core/src/main/java/org/apache/maven/api/Project.java:
##########
@@ -37,24 +37,66 @@
 @Experimental
 public interface Project {
 
+    /**
+     * Returns the project groupId.
+     */
     @Nonnull
     String getGroupId();
 
+    /**
+     * Returns the project artifactId.
+     */
     @Nonnull
     String getArtifactId();
 
+    /**
+     * Returns the project version.
+     */
     @Nonnull
     String getVersion();
 
+    /**
+     * Returns the project packaging.
+     * <p>
+     * Note: unlike in legacy code, logical checks against string representing 
packaging (returned by this method)
+     * are NOT recommended (code like {@code 
"pom".equals(project.getPackaging)} must be avoided). Use method
+     * {@link #getArtifacts()} to gain access to POM or build artifact.
+     *
+     * @see #getArtifacts()
+     */
     @Nonnull
     String getPackaging();
 
+    /**
+     * Returns the project artifact, that is the artifact produced by this 
project build.
+     *
+     * @see org.apache.maven.api.services.ArtifactManager#getPath(Artifact)
+     */
     @Nonnull
     Artifact getArtifact();
 
+    /**
+     * Returns the project artifacts, that is, the project POM artifact and 
the artifact produced by this project build.

Review Comment:
   which are





> New method for project artifacts
> --------------------------------
>
>                 Key: MNG-8023
>                 URL: https://issues.apache.org/jira/browse/MNG-8023
>             Project: Maven
>          Issue Type: Task
>          Components: API
>            Reporter: Tamas Cservenak
>            Priority: Major
>             Fix For: 4.0.0, 4.0.0-alpha-13
>
>
> Introduce a new method on API Project object that exposes "main artifacts" of 
> project. The method can return 1 or 2 artifacts (never less than 1 and never 
> more than 2). These are NOT the attached artifacts! (see ProjectManager for 
> that).
> In short: projects with packaging "pom", "bom" (that produce only one 
> artifact) will on this method return 1 artifact, while projects for example 
> with packaging "jar" will return 2 artifacts (as they produce, install, 
> deploy two artifacts, the POM and the JAR/WAR/etc).



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to