Author: rfscholte
Date: Sun Feb 28 13:30:07 2016
New Revision: 1732733
URL: http://svn.apache.org/viewvc?rev=1732733&view=rev
Log:
Improve javadoc
Modified:
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/ArtifactCoordinate.java
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependency/DependencyCoordinate.java
Modified:
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/ArtifactCoordinate.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/ArtifactCoordinate.java?rev=1732733&r1=1732732&r2=1732733&view=diff
==============================================================================
---
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/ArtifactCoordinate.java
(original)
+++
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/ArtifactCoordinate.java
Sun Feb 28 13:30:07 2016
@@ -24,10 +24,6 @@ package org.apache.maven.shared.artifact
* Contains all required elements of a Maven Artifact to resolve and calculate
its path for either a local or
* remote Maven2 repository.
* </p>
- * <p>
- * The type will be translated to an extension based on the artifact
descriptor ({@code pom.xml} matching the groupId,
- * artifactId and version.
- * </p>
*
* @author Robert Scholte
*/
@@ -44,14 +40,16 @@ public interface ArtifactCoordinate
String getArtifactId();
/**
- * A version or versionRange
+ * A version, never a versionRange
*
* @return The version.
*/
String getVersion();
/**
- * @return The type of the artifact.
+ * The file-extension of the artifact.
+ *
+ * @return The extension.
*/
String getExtension();
Modified:
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependency/DependencyCoordinate.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependency/DependencyCoordinate.java?rev=1732733&r1=1732732&r2=1732733&view=diff
==============================================================================
---
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependency/DependencyCoordinate.java
(original)
+++
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependency/DependencyCoordinate.java
Sun Feb 28 13:30:07 2016
@@ -36,18 +36,34 @@ package org.apache.maven.shared.dependen
*/
public interface DependencyCoordinate
{
+ /**
+ *
+ * @return the groupId of the dependency
+ */
String getGroupId();
+ /**
+ *
+ * @return the artifact of the dependency
+ */
String getArtifactId();
/**
* A version or versionRange
*
- * @return
+ * @return the version
*/
String getVersion();
+ /**
+ *
+ * @return the type of the artifact
+ */
String getType();
+ /**
+ *
+ * @return the classifier or {@code null}
+ */
String getClassifier();
}
\ No newline at end of file
