Author: khmarbaise
Date: Fri Dec 18 17:10:42 2015
New Revision: 1720827
URL: http://svn.apache.org/viewvc?rev=1720827&view=rev
Log:
Cleaning up checkstyle reported errors/warnings
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/artifact/DefaultArtifactCoordinate.java
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/TransferUtils.java
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/collect/CollectorResult.java
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/collect/DependencyCollector.java
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/collect/DependencyCollectorException.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=1720827&r1=1720826&r2=1720827&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
Fri Dec 18 17:10:42 2015
@@ -36,18 +36,30 @@ package org.apache.maven.shared.artifact
*/
public interface ArtifactCoordinate
{
+ /**
+ * @return The groupId of the artifact.
+ */
String getGroupId();
+ /**
+ * @return The artifactId of the artifact.
+ */
String getArtifactId();
/**
* A version or versionRange
*
- * @return
+ * @return The version.
*/
String getVersion();
+ /**
+ * @return The type of the artifact.
+ */
String getType();
+ /**
+ * @return The classifier of the artifact.
+ */
String getClassifier();
}
\ No newline at end of file
Modified:
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/DefaultArtifactCoordinate.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/DefaultArtifactCoordinate.java?rev=1720827&r1=1720826&r2=1720827&view=diff
==============================================================================
---
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/DefaultArtifactCoordinate.java
(original)
+++
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/DefaultArtifactCoordinate.java
Fri Dec 18 17:10:42 2015
@@ -98,6 +98,9 @@ public class DefaultArtifactCoordinate i
return groupId;
}
+ /**
+ * @param groupId The groupId to be used.
+ */
public final void setGroupId( String groupId )
{
this.groupId = groupId;
@@ -109,6 +112,9 @@ public class DefaultArtifactCoordinate i
return artifactId;
}
+ /**
+ * @param artifactId The artifactId to be used.
+ */
public final void setArtifactId( String artifactId )
{
this.artifactId = artifactId;
@@ -120,6 +126,9 @@ public class DefaultArtifactCoordinate i
return version;
}
+ /**
+ * @param version The version to be used.
+ */
public final void setVersion( String version )
{
this.version = version;
@@ -131,6 +140,9 @@ public class DefaultArtifactCoordinate i
return type != null ? type : "jar";
}
+ /**
+ * @param type The type to be used.
+ */
public final void setType( String type )
{
this.type = type;
@@ -142,6 +154,9 @@ public class DefaultArtifactCoordinate i
return classifier;
}
+ /**
+ * @param classifier The classifier to be used.
+ */
public final void setClassifier( String classifier )
{
this.classifier = classifier;
Modified:
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/TransferUtils.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/TransferUtils.java?rev=1720827&r1=1720826&r2=1720827&view=diff
==============================================================================
---
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/TransferUtils.java
(original)
+++
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/TransferUtils.java
Fri Dec 18 17:10:42 2015
@@ -38,6 +38,10 @@ public final class TransferUtils
{
}
+ /**
+ * @param artifact {@link Artifact}
+ * @return {@link ArtifactCoordinate}
+ */
public static ArtifactCoordinate toArtifactCoordinate( Artifact artifact )
{
DefaultArtifactCoordinate coordinate = new DefaultArtifactCoordinate();
@@ -51,6 +55,10 @@ public final class TransferUtils
return coordinate;
}
+ /**
+ * @param dependency {@link Dependency}
+ * @return {@link ArtifactCoordinate}
+ */
public static ArtifactCoordinate toArtifactCoordinate( Dependency
dependency )
{
DefaultArtifactCoordinate coordinate = new DefaultArtifactCoordinate();
@@ -64,6 +72,10 @@ public final class TransferUtils
return coordinate;
}
+ /**
+ * @param extension {@link Extension}
+ * @return {@link ArtifactCoordinate}
+ */
public static ArtifactCoordinate toArtifactCoordinate( Extension extension
)
{
DefaultArtifactCoordinate coordinate = new DefaultArtifactCoordinate();
@@ -75,6 +87,10 @@ public final class TransferUtils
return coordinate;
}
+ /**
+ * @param project {@link MavenProject}
+ * @return {@link ArtifactCoordinate}
+ */
public static ArtifactCoordinate toArtifactCoordinate( MavenProject
project )
{
DefaultArtifactCoordinate coordinate = new DefaultArtifactCoordinate();
@@ -87,6 +103,10 @@ public final class TransferUtils
return coordinate;
}
+ /**
+ * @param parent {@link Parent}
+ * @return {@link ArtifactCoordinate}
+ */
public static ArtifactCoordinate toArtifactCoordinate( Parent parent )
{
DefaultArtifactCoordinate coordinate = new DefaultArtifactCoordinate();
@@ -99,6 +119,10 @@ public final class TransferUtils
return coordinate;
}
+ /**
+ * @param plugin {@link Plugin}
+ * @return {@link ArtifactCoordinate}
+ */
public static ArtifactCoordinate toArtifactCoordinate( Plugin plugin )
{
DefaultArtifactCoordinate coordinate = new DefaultArtifactCoordinate();
@@ -111,6 +135,10 @@ public final class TransferUtils
return coordinate;
}
+ /**
+ * @param artifact {@link Artifact}
+ * @return {@link Dependency}
+ */
public static Dependency toDependency( Artifact artifact )
{
Dependency dependency = new Dependency();
@@ -125,6 +153,10 @@ public final class TransferUtils
return dependency;
}
+ /**
+ * @param coordinate {@link ArtifactCoordinate}
+ * @return {@link Dependency}
+ */
public static Dependency toDependency( ArtifactCoordinate coordinate )
{
Dependency dependency = new Dependency();
Modified:
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/collect/CollectorResult.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/collect/CollectorResult.java?rev=1720827&r1=1720826&r2=1720827&view=diff
==============================================================================
---
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/collect/CollectorResult.java
(original)
+++
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/collect/CollectorResult.java
Fri Dec 18 17:10:42 2015
@@ -30,5 +30,8 @@ import org.apache.maven.artifact.reposit
*/
public interface CollectorResult
{
+ /**
+ * @return {@link ArtifactRepository}
+ */
List<ArtifactRepository> getRemoteRepositories();
}
Modified:
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/collect/DependencyCollector.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/collect/DependencyCollector.java?rev=1720827&r1=1720826&r2=1720827&view=diff
==============================================================================
---
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/collect/DependencyCollector.java
(original)
+++
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/collect/DependencyCollector.java
Fri Dec 18 17:10:42 2015
@@ -32,9 +32,21 @@ import org.apache.maven.project.ProjectB
public interface DependencyCollector
{
+ /**
+ * @param buildingRequest {@link ProjectBuildingRequest}
+ * @param root {@link Dependency}
+ * @return {@link CollectorResult}
+ * @throws DependencyCollectorException in case of an error.
+ */
CollectorResult collectDependencies( ProjectBuildingRequest
buildingRequest, Dependency root )
throws DependencyCollectorException;
+ /**
+ * @param buildingRequest {@link ProjectBuildingRequest}
+ * @param root {@link Artifact}
+ * @return {@link CollectorResult}
+ * @throws DependencyCollectorException in case of an error.
+ */
CollectorResult collectDependencies( ProjectBuildingRequest
buildingRequest, Artifact root )
throws DependencyCollectorException;
Modified:
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/collect/DependencyCollectorException.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/collect/DependencyCollectorException.java?rev=1720827&r1=1720826&r2=1720827&view=diff
==============================================================================
---
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/collect/DependencyCollectorException.java
(original)
+++
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/collect/DependencyCollectorException.java
Fri Dec 18 17:10:42 2015
@@ -26,6 +26,15 @@ package org.apache.maven.shared.artifact
public class DependencyCollectorException extends Exception
{
+ /**
+ *
+ */
+ private static final long serialVersionUID = -180986912170441437L;
+
+ /**
+ * @param message The message you would give for the exception.
+ * @param cause The cause which is related to the message.
+ */
public DependencyCollectorException( String message, Throwable cause )
{
super( message, cause );
