michael-o commented on code in PR #1387:
URL: https://github.com/apache/maven/pull/1387#discussion_r1459202586
##########
api/maven-api-core/src/main/java/org/apache/maven/api/Project.java:
##########
@@ -37,24 +37,58 @@
@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.
+ */
@Nonnull
String getPackaging();
+ /**
+ * Returns the project artifact, that is the artifact produced by this
project. If the artifact file exists, it is
+ * registered to {@link org.apache.maven.api.services.ArtifactManager}.
+ *
+ * @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.
+ * The list may have 1 or 2 elements (never less than 1, never more than
2), depending on project packaging. If
Review Comment:
one or two
##########
api/maven-api-core/src/main/java/org/apache/maven/api/Project.java:
##########
@@ -37,24 +37,58 @@
@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.
+ */
@Nonnull
String getPackaging();
+ /**
+ * Returns the project artifact, that is the artifact produced by this
project. If the artifact file exists, it is
+ * registered to {@link org.apache.maven.api.services.ArtifactManager}.
+ *
+ * @see org.apache.maven.api.services.ArtifactManager#getPath(Artifact)
+ */
@Nonnull
Review Comment:
This should tell whether this is the main artifact or the POM. Must be in
send with the plural method.
##########
api/maven-api-core/src/main/java/org/apache/maven/api/Project.java:
##########
@@ -37,24 +37,58 @@
@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.
+ */
@Nonnull
String getPackaging();
+ /**
+ * Returns the project artifact, that is the artifact produced by this
project. If the artifact file exists, it is
+ * registered to {@link org.apache.maven.api.services.ArtifactManager}.
+ *
+ * @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.
+ * The list may have 1 or 2 elements (never less than 1, never more than
2), depending on project packaging. If
+ * artifact files exists, they are registered to {@link
org.apache.maven.api.services.ArtifactManager}.
+ *
+ * @see org.apache.maven.api.services.ArtifactManager#getPath(Artifact)
+ */
+ @Nonnull
+ List<Artifact> getArtifacts();
Review Comment:
Will this include the artifact from above?
--
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: issues-unsubscr...@maven.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
