Author: sisbell
Date: Sat Jul 19 14:56:37 2008
New Revision: 678229
URL: http://svn.apache.org/viewvc?rev=678229&view=rev
Log:
Updated javadocs.
Modified:
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/ArtifactModelContainerFactory.java
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/IdModelContainerFactory.java
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/PomArtifactResolver.java
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/PomClassicDomainModel.java
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/PomClassicTransformer.java
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/ProjectBuilder.java
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/impl/DefaultProjectBuilder.java
Modified:
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/ArtifactModelContainerFactory.java
URL:
http://svn.apache.org/viewvc/maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/ArtifactModelContainerFactory.java?rev=678229&r1=678228&r2=678229&view=diff
==============================================================================
---
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/ArtifactModelContainerFactory.java
(original)
+++
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/ArtifactModelContainerFactory.java
Sat Jul 19 14:56:37 2008
@@ -24,7 +24,11 @@
import org.apache.maven.shared.model.ModelContainerFactory;
import org.apache.maven.shared.model.ModelProperty;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
public final class ArtifactModelContainerFactory
implements ModelContainerFactory
@@ -167,10 +171,6 @@
return properties;
}
- public void sort( List<ModelProperty> modelProperties )
- {
- }
-
public String toString()
{
StringBuffer sb = new StringBuffer();
Modified:
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/IdModelContainerFactory.java
URL:
http://svn.apache.org/viewvc/maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/IdModelContainerFactory.java?rev=678229&r1=678228&r2=678229&view=diff
==============================================================================
---
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/IdModelContainerFactory.java
(original)
+++
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/IdModelContainerFactory.java
Sat Jul 19 14:56:37 2008
@@ -24,7 +24,11 @@
import org.apache.maven.shared.model.ModelContainerFactory;
import org.apache.maven.shared.model.ModelProperty;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
public class IdModelContainerFactory
implements ModelContainerFactory
@@ -96,11 +100,6 @@
return new IdModelContainer( modelProperties );
}
- public void sort( List<ModelProperty> modelProperties )
- {
-
- }
-
public List<ModelProperty> getProperties()
{
return properties;
Modified:
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/PomArtifactResolver.java
URL:
http://svn.apache.org/viewvc/maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/PomArtifactResolver.java?rev=678229&r1=678228&r2=678229&view=diff
==============================================================================
---
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/PomArtifactResolver.java
(original)
+++
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/PomArtifactResolver.java
Sat Jul 19 14:56:37 2008
@@ -29,6 +29,9 @@
import java.io.IOException;
import java.util.List;
+/**
+ * Provides methods for resolving of artifacts.
+ */
public class PomArtifactResolver
{
Modified:
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/PomClassicDomainModel.java
URL:
http://svn.apache.org/viewvc/maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/PomClassicDomainModel.java?rev=678229&r1=678228&r2=678229&view=diff
==============================================================================
---
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/PomClassicDomainModel.java
(original)
+++
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/PomClassicDomainModel.java
Sat Jul 19 14:56:37 2008
@@ -29,7 +29,11 @@
import org.codehaus.plexus.util.WriterFactory;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
-import java.io.*;
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.Writer;
/**
* Provides a wrapper for the maven model.
@@ -38,8 +42,14 @@
implements InputStreamDomainModel
{
+ /**
+ * Bytes containing the underlying model
+ */
private byte[] inputBytes;
+ /**
+ * History of joins and deletes of model properties
+ */
private String eventHistory;
/**
Modified:
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/PomClassicTransformer.java
URL:
http://svn.apache.org/viewvc/maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/PomClassicTransformer.java?rev=678229&r1=678228&r2=678229&view=diff
==============================================================================
---
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/PomClassicTransformer.java
(original)
+++
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/PomClassicTransformer.java
Sat Jul 19 14:56:37 2008
@@ -20,13 +20,22 @@
*/
import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
-import org.apache.maven.shared.model.*;
+import org.apache.maven.shared.model.DomainModel;
+import org.apache.maven.shared.model.ModelContainer;
+import org.apache.maven.shared.model.ModelDataSource;
+import org.apache.maven.shared.model.ModelMarshaller;
+import org.apache.maven.shared.model.ModelProperty;
+import org.apache.maven.shared.model.ModelTransformer;
import org.apache.maven.shared.model.impl.DefaultModelDataSource;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
import java.io.IOException;
import java.io.StringReader;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
/**
* Provides methods for transforming model properties into a domain model for
the pom classic format and vice versa.
Modified:
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/ProjectBuilder.java
URL:
http://svn.apache.org/viewvc/maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/ProjectBuilder.java?rev=678229&r1=678228&r2=678229&view=diff
==============================================================================
---
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/ProjectBuilder.java
(original)
+++
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/ProjectBuilder.java
Sat Jul 19 14:56:37 2008
@@ -29,11 +29,25 @@
import java.util.Collection;
import java.util.List;
+/**
+ * Provides services for building maven projects from models.
+ */
public interface ProjectBuilder
{
String ROLE = ProjectBuilder.class.getName();
+ /**
+ * Returns a maven project for the specified input stream.
+ *
+ * @param pom input stream of the model
+ * @param inheritedModels list of models containing additional
parent models in order from most to least specialized
+ * @param interpolatorProperties properties used for interpolation of
properties within the model
+ * @param resolver artifact resolver used in resolving
artifacts
+ * @param baseDirectory the base directory of the model
+ * @return a maven project for the specified input stream
+ * @throws IOException if there is a problem in the construction of the
maven project
+ */
MavenProject buildFromLocalPath( InputStream pom, List<Model>
inheritedModels,
Collection<InterpolatorProperty>
interpolatorProperties,
PomArtifactResolver resolver, File
baseDirectory )
Modified:
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/impl/DefaultProjectBuilder.java
URL:
http://svn.apache.org/viewvc/maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/impl/DefaultProjectBuilder.java?rev=678229&r1=678228&r2=678229&view=diff
==============================================================================
---
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/impl/DefaultProjectBuilder.java
(original)
+++
maven/sandbox/branches/SI_MAVEN_2_1_A/maven-project/src/main/java/org/apache/maven/project/builder/impl/DefaultProjectBuilder.java
Sat Jul 19 14:56:37 2008
@@ -24,7 +24,12 @@
import org.apache.maven.model.Model;
import org.apache.maven.model.Parent;
import org.apache.maven.project.MavenProject;
-import org.apache.maven.project.builder.*;
+import org.apache.maven.project.builder.ArtifactModelContainerFactory;
+import org.apache.maven.project.builder.IdModelContainerFactory;
+import org.apache.maven.project.builder.PomArtifactResolver;
+import org.apache.maven.project.builder.PomClassicDomainModel;
+import org.apache.maven.project.builder.PomClassicTransformer;
+import org.apache.maven.project.builder.ProjectBuilder;
import org.apache.maven.project.validation.ModelValidationResult;
import org.apache.maven.project.validation.ModelValidator;
import org.apache.maven.shared.model.DomainModel;
@@ -37,22 +42,40 @@
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
-import java.util.*;
-
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+
+/**
+ * Default implementation of the project builder.
+ */
public final class DefaultProjectBuilder
implements ProjectBuilder, LogEnabled
{
private ArtifactFactory artifactFactory;
+ /**
+ * Logger instance
+ */
private Logger logger;
private ModelValidator validator;
+ /**
+ * Default constructor
+ */
public DefaultProjectBuilder()
{
}
+ /**
+ * Constructor
+ *
+ * @param artifactFactory the artifact factory
+ */
protected DefaultProjectBuilder( ArtifactFactory artifactFactory )
{
if ( artifactFactory == null )
@@ -62,6 +85,9 @@
this.artifactFactory = artifactFactory;
}
+ /**
+ * @see ProjectBuilder#buildFromLocalPath(java.io.InputStream,
java.util.List, java.util.Collection,
org.apache.maven.project.builder.PomArtifactResolver, java.io.File)
+ */
public MavenProject buildFromLocalPath( InputStream pom, List<Model>
inheritedModels,
Collection<InterpolatorProperty>
interpolatorProperties,
PomArtifactResolver resolver, File
projectDirectory )
