maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hbout...@apache.org
Subject svn commit: r1147326 - in /maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui: ./ creation/ generation/
Date Fri, 15 Jul 2011 21:45:59 GMT
Author: hboutemy
Date: Fri Jul 15 21:45:56 2011
New Revision: 1147326

URL: http://svn.apache.org/viewvc?rev=1147326&view=rev
Log:
improved javadoc

Added:
    maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/creation/package.html
  (with props)
    maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/package.html
  (with props)
    maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/package.html
  (with props)
Modified:
    maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/ArchetypeFactory.java
    maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/DefaultArchetypeFactory.java
    maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/creation/ArchetypeCreationConfigurator.java
    maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/creation/ArchetypeCreationQueryer.java
    maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/ArchetypeGenerationConfigurator.java
    maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/ArchetypeGenerationQueryer.java
    maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/ArchetypeSelectionQueryer.java
    maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/ArchetypeSelector.java

Modified: maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/ArchetypeFactory.java
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/ArchetypeFactory.java?rev=1147326&r1=1147325&r2=1147326&view=diff
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/ArchetypeFactory.java
(original)
+++ maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/ArchetypeFactory.java
Fri Jul 15 21:45:56 2011
@@ -27,6 +27,8 @@ public interface ArchetypeFactory
 {
     String ROLE = ArchetypeFactory.class.getName();
 
+    ArchetypeDefinition createArchetypeDefinition( Properties properties );
+
     ArchetypeConfiguration createArchetypeConfiguration( org.apache.maven.archetype.old.descriptor.ArchetypeDescriptor
archetypeDescriptor,
                                                          Properties properties );
 
@@ -36,8 +38,6 @@ public interface ArchetypeFactory
     ArchetypeConfiguration createArchetypeConfiguration( MavenProject project, ArchetypeDefinition
archetypeDefinition,
                                                          Properties properties );
 
-    ArchetypeDefinition createArchetypeDefinition( Properties properties );
-
     void updateArchetypeConfiguration( ArchetypeConfiguration archetypeConfiguration,
                                        ArchetypeDefinition archetypeDefinition );
 }

Modified: maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/DefaultArchetypeFactory.java
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/DefaultArchetypeFactory.java?rev=1147326&r1=1147325&r2=1147326&view=diff
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/DefaultArchetypeFactory.java
(original)
+++ maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/DefaultArchetypeFactory.java
Fri Jul 15 21:45:56 2011
@@ -35,6 +35,25 @@ public class DefaultArchetypeFactory
     extends AbstractLogEnabled
     implements ArchetypeFactory
 {
+    public ArchetypeDefinition createArchetypeDefinition( Properties properties )
+    {
+        ArchetypeDefinition definition = new ArchetypeDefinition();
+
+        definition.setGroupId( properties.getProperty( Constants.ARCHETYPE_GROUP_ID ) );
+
+        definition.setArtifactId( properties.getProperty( Constants.ARCHETYPE_ARTIFACT_ID
) );
+
+        definition.setVersion( properties.getProperty( Constants.ARCHETYPE_VERSION ) );
+
+        definition.setRepository( properties.getProperty( Constants.ARCHETYPE_REPOSITORY
) );
+
+        definition.setUrl( properties.getProperty( Constants.ARCHETYPE_URL ) );
+
+        definition.setDescription( properties.getProperty( Constants.ARCHETYPE_DESCRIPTION
) );
+
+        return definition;
+    }
+
     private void addOldRequiredProperty( ArchetypeConfiguration configuration, Properties
properties, String key,
                                          String defaultValue, boolean initPropertyWithDefault
)
     {
@@ -216,25 +235,6 @@ public class DefaultArchetypeFactory
         return configuration;
     }
 
-    public ArchetypeDefinition createArchetypeDefinition( Properties properties )
-    {
-        ArchetypeDefinition definition = new ArchetypeDefinition();
-
-        definition.setGroupId( properties.getProperty( Constants.ARCHETYPE_GROUP_ID ) );
-
-        definition.setArtifactId( properties.getProperty( Constants.ARCHETYPE_ARTIFACT_ID
) );
-
-        definition.setVersion( properties.getProperty( Constants.ARCHETYPE_VERSION ) );
-
-        definition.setRepository( properties.getProperty( Constants.ARCHETYPE_REPOSITORY
) );
-
-        definition.setUrl( properties.getProperty( Constants.ARCHETYPE_URL ) );
-
-        definition.setDescription( properties.getProperty( Constants.ARCHETYPE_DESCRIPTION
) );
-
-        return definition;
-    }
-
     private ArchetypeConfiguration createArchetypeConfiguration( Properties properties )
     {
         ArchetypeConfiguration configuration = new ArchetypeConfiguration();

Modified: maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/creation/ArchetypeCreationConfigurator.java
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/creation/ArchetypeCreationConfigurator.java?rev=1147326&r1=1147325&r2=1147326&view=diff
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/creation/ArchetypeCreationConfigurator.java
(original)
+++ maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/creation/ArchetypeCreationConfigurator.java
Fri Jul 15 21:45:56 2011
@@ -31,6 +31,9 @@ import java.io.IOException;
 import java.util.List;
 import java.util.Properties;
 
+/**
+ * Configurator component to organize steps for archetype creation from a project.
+ */
 public interface ArchetypeCreationConfigurator
 {
     String ROLE = ArchetypeCreationConfigurator.class.getName();

Modified: maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/creation/ArchetypeCreationQueryer.java
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/creation/ArchetypeCreationQueryer.java?rev=1147326&r1=1147325&r2=1147326&view=diff
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/creation/ArchetypeCreationQueryer.java
(original)
+++ maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/creation/ArchetypeCreationQueryer.java
Fri Jul 15 21:45:56 2011
@@ -22,6 +22,11 @@ package org.apache.maven.archetype.ui.cr
 import org.apache.maven.archetype.ui.ArchetypeConfiguration;
 import org.codehaus.plexus.components.interactivity.PrompterException;
 
+/**
+ * User interaction component to query informations necessary for an archetype creation from
a project.
+ * 
+ * @todo this interface is bound to its implementation through the prompter exception
+ */
 public interface ArchetypeCreationQueryer
 {
     String ROLE = ArchetypeCreationQueryer.class.getName();

Added: maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/creation/package.html
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/creation/package.html?rev=1147326&view=auto
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/creation/package.html
(added)
+++ maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/creation/package.html
Fri Jul 15 21:45:56 2011
@@ -0,0 +1,3 @@
+<body>
+  User Interaction for archetype creation from a project.
+</body>
\ No newline at end of file

Propchange: maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/creation/package.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/creation/package.html
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Propchange: maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/creation/package.html
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Modified: maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/ArchetypeGenerationConfigurator.java
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/ArchetypeGenerationConfigurator.java?rev=1147326&r1=1147325&r2=1147326&view=diff
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/ArchetypeGenerationConfigurator.java
(original)
+++ maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/ArchetypeGenerationConfigurator.java
Fri Jul 15 21:45:56 2011
@@ -29,6 +29,9 @@ import org.codehaus.plexus.components.in
 import java.io.IOException;
 import java.util.Properties;
 
+/**
+ * Configurator component to organize steps for project generation from an archetype.
+ */
 public interface ArchetypeGenerationConfigurator
 {
     String ROLE = ArchetypeGenerationConfigurator.class.getName();

Modified: maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/ArchetypeGenerationQueryer.java
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/ArchetypeGenerationQueryer.java?rev=1147326&r1=1147325&r2=1147326&view=diff
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/ArchetypeGenerationQueryer.java
(original)
+++ maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/ArchetypeGenerationQueryer.java
Fri Jul 15 21:45:56 2011
@@ -22,6 +22,11 @@ package org.apache.maven.archetype.ui.ge
 import org.apache.maven.archetype.ui.ArchetypeConfiguration;
 import org.codehaus.plexus.components.interactivity.PrompterException;
 
+/**
+ * User interaction component to query informations necessary for a project generation from
an archetype.
+ * 
+ * @todo this interface is bound to its implementation through the prompter exception
+ */
 public interface ArchetypeGenerationQueryer
 {
     boolean confirmConfiguration( ArchetypeConfiguration archetypeConfiguration )

Modified: maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/ArchetypeSelectionQueryer.java
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/ArchetypeSelectionQueryer.java?rev=1147326&r1=1147325&r2=1147326&view=diff
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/ArchetypeSelectionQueryer.java
(original)
+++ maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/ArchetypeSelectionQueryer.java
Fri Jul 15 21:45:56 2011
@@ -27,6 +27,8 @@ import java.util.List;
 import java.util.Map;
 
 /**
+ * User interaction component for archetype selection.
+ * 
  * @todo this interface is bound to its implementation through the prompter exception
  */
 public interface ArchetypeSelectionQueryer

Modified: maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/ArchetypeSelector.java
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/ArchetypeSelector.java?rev=1147326&r1=1147325&r2=1147326&view=diff
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/ArchetypeSelector.java
(original)
+++ maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/ArchetypeSelector.java
Fri Jul 15 21:45:56 2011
@@ -28,6 +28,9 @@ import org.codehaus.plexus.components.in
 
 import java.io.IOException;
 
+/**
+ * Selection component to organize steps to choose an archetype.
+ */
 //TODO: We should need any remote repositories here, we should simply be doing selection,
any remote catalogs
 //      should be validating correctness, and if it so happens we get a crap entry then the
generation mechanism
 //      should take care of reporting the error. The selector should not be downloading anything.

Added: maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/package.html
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/package.html?rev=1147326&view=auto
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/package.html
(added)
+++ maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/package.html
Fri Jul 15 21:45:56 2011
@@ -0,0 +1,3 @@
+<body>
+  User Interaction for project creation from an archetype.
+</body>
\ No newline at end of file

Propchange: maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/package.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/package.html
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Propchange: maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/generation/package.html
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Added: maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/package.html
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/package.html?rev=1147326&view=auto
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/package.html
(added)
+++ maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/package.html
Fri Jul 15 21:45:56 2011
@@ -0,0 +1,3 @@
+<body>
+  User Interaction tooling for command-line use.
+</body>
\ No newline at end of file

Propchange: maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/package.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/package.html
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Propchange: maven/archetype/trunk/maven-archetype-plugin/src/main/java/org/apache/maven/archetype/ui/package.html
------------------------------------------------------------------------------
    svn:mime-type = text/plain



Mime
View raw message