You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by ka...@apache.org on 2003/05/24 01:13:46 UTC
cvs commit: maven-new/core/src/java/org/apache/maven/artifact Artifact.java
kaz 2003/05/23 16:13:45
Modified: core/src/java/org/apache/maven/artifact Artifact.java
Log:
All formatting changes geared to making the file easier to read
(explicit public indentifiers, getters/setters co-located, etc.)
Revision Changes Path
1.6 +70 -71 maven-new/core/src/java/org/apache/maven/artifact/Artifact.java
Index: Artifact.java
===================================================================
RCS file: /home/cvs/maven-new/core/src/java/org/apache/maven/artifact/Artifact.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- Artifact.java 23 May 2003 22:48:59 -0000 1.5
+++ Artifact.java 23 May 2003 23:13:44 -0000 1.6
@@ -1,3 +1,5 @@
+package org.apache.maven.artifact;
+
/* ====================================================================
* The Apache Software License, Version 1.1
*
@@ -53,7 +55,6 @@
*
* ====================================================================
*/
-package org.apache.maven.artifact;
import org.apache.maven.project.Dependency;
@@ -63,159 +64,157 @@
* The interface defining an artifact (which probably lives in the
* repository).
*
- *
* @author <a href="jason@zenplex.com">Jason van Zyl</a>
* @author <a href="michal.maczka@dimatics.com">Michal Maczka</a>
* @version $Id$
*/
public interface Artifact
{
-
- /**
- * Set the dependency for this JAR artifact.
- *
- * @param dependency Dependency this artifact is based on.
- */
- void setDependency( Dependency dependency );
-
/**
* Get the dependency.
*
* @return The dependency this artifact is based on.
*/
- Dependency getDependency();
+ public Dependency getDependency();
/**
- * Returns id which is "groupId:artifactId"
- * @return id of this artifact
+ * Set the dependency for this JAR artifact.
+ *
+ * @param dependency Dependency this artifact is based on.
*/
- String getId();
+ public void setDependency( Dependency dependency );
/**
* Get the artifactId
+ *
* @return artifactId for the artifact
*/
- String getArtifactId();
+ public String getArtifactId();
/**
* Set artifactId
- * @param artifactId The artifactId for the artifact
- */
- void setArtifactId( String artifactId );
-
- /**
- * Set the group id.
*
- * @param groupId Group id for the artifact.
+ * @param artifactId The artifactId for the artifact
*/
- void setGroupId( String groupId );
+ public void setArtifactId( String artifactId );
/**
* Get the group id.
*
* @return The group id for the artifact.
*/
- String getGroupId();
+ public String getGroupId();
/**
- * Set the version for this artifact.
+ * Set the group id.
*
- * @param version Version for this artifact
+ * @param groupId Group id for the artifact.
*/
- void setVersion( String version );
+ public void setGroupId( String groupId );
/**
* Get the version of this artifact.
*
* @return Version of this artifact
*/
- String getVersion();
+ public String getVersion();
+
+ /**
+ * Set the version for this artifact.
+ *
+ * @param version Version for this artifact
+ */
+ public void setVersion( String version );
/**
* Get the type of the artifact.
*
* @return dependency type such as "compile" or "test"
*/
- String getType();
+ public String getType();
/**
* Sets the dependency type such as "compile" or "test"
*
* @param type The type of artifact.
*/
- void setType( String type );
+ public void setType( String type );
+
+ /**
+ * Return a path that is platform agnostic.
+ *
+ * @return URL of the artifact.
+ */
+ public String getPath();
/**
* Set the path to the artifact.
*
* @param path Path to the artifact.
*/
- void setPath( String path );
+ public void setPath( String path );
-
/**
- * Set the path to the artifact. The maven jar override facilty can be
- * used to change the path to the artifact if the user specifies the
- * use of a specific version.
- *
- * @param path Path to the artifact.
- */
- void setFile( String file );
-
-
+ * Get the location of the artifact in the local file system.
+ *
+ * @return The location of the artifact in the local file system.
+ */
+ public File getFile();
+
/**
- * Return a path that is platform agnostic.
+ * Set the path to the artifact. The maven jar override facilty
+ * can be used to change the path to the artifact if the user
+ * specifies the use of a specific version.
*
- * @return URL of the artifact.
+ * @param path Path to the artifact.
*/
- String getPath();
+ public void setFile( String file );
/**
+ * Sets the flag which indicates
+ * if file override mechanism was applied to this artifact
+ */
+ public void setOveridden( boolean overriden );
+
+ /**
+ * Gets the flag is artifact has been overriden
+ * @return
+ */
+ public boolean isOverridden();
+
+ /**
+ * Returns id which is "groupId:artifactId"
+ *
+ * @return id of this artifact
+ */
+ public String getId();
+
+ /**
* Return an URL path that is platform agnostic.
*
* @return URL of the artifact.
*/
- String getUrlPath();
+ public String getUrlPath();
/**
* Return the url to the checksum file for this artifact.
*
* @return URL of the checksum file for this artifact.
*/
- String getChecksumUrl();
+ public String getChecksumUrl();
/**
* Boolean flag indicating whether this artifact is a snapshot.
*
* @return Flag indicating whether this artifact is a snapshot.
*/
- boolean isSnapshot();
+ public boolean isSnapshot();
/**
* Boolean flag indicating whether this artifact exists.
*
- * @return Flag indicating the existance of the artifact in the local repository.
+ * @return Flag indicating the existance of the artifact in the
+ * local repository.
*/
- boolean exists();
-
- /**
- * Get the location of the artifact in the local file system.
- *
- * @return The location of the artifact in the local file system.
- */
- File getFile();
-
- /**
- * Sets the flag which indicates
- * if file override mechanism was applied to this artifact
- */
- void setOveridden( boolean overriden);
-
- /**
- * Gets the flag is artifact has been overriden
- * @return
- */
- boolean isOverridden();
-
-
+ public boolean exists();
}
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org