org.apache.maven.archetype.mojos

Class CreateProjectFromArchetypeMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.archetype.mojos.CreateProjectFromArchetypeMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="generate",
      requiresProject=false)
 @Execute(phase=GENERATE_SOURCES)
public class CreateProjectFromArchetypeMojo
extends org.apache.maven.plugin.AbstractMojo
implements org.apache.maven.plugin.ContextEnabled

Generates a new project from an archetype, or updates the actual project if using a partial archetype. If the project is fully generated, it is generated in a directory corresponding to its artifactId. If the project is updated with a partial archetype, it is done in the current directory.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	archetypeArtifactId The archetype's artifactId.
private java.lang.String	archetypeCatalog The archetype catalogs to use to build a list and let the user choose from.
private java.lang.String	archetypeGroupId The archetype's groupId.
private java.lang.String	archetypeRepository The archetype's repository.
private java.lang.String	archetypeVersion The archetype's version.
private java.io.File	basedir
private ArchetypeGenerationConfigurator	configurator
private java.lang.String	filter Applying some filter on displayed archetypes list: format is artifactId or groupId:artifactId.
private java.lang.String	goals Additional goals to immediately run on the project created from the archetype.
private java.lang.Boolean	interactiveMode User settings used to check the interactiveMode.
private org.apache.maven.shared.invoker.Invoker	invoker
private org.apache.maven.artifact.repository.ArtifactRepository	localRepository Local Maven repository.
private ArchetypeManager	manager
private java.util.List<org.apache.maven.artifact.repository.ArtifactRepository>	remoteArtifactRepositories List of remote repositories used by the resolver.
private ArchetypeSelector	selector
private org.apache.maven.execution.MavenSession	session

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
CreateProjectFromArchetypeMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
private void	invokePostArchetypeGenerationGoals(java.lang.String goals, java.lang.String artifactId)

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.plugin.ContextEnabled

getPluginContext, setPluginContext

Field Detail

manager

@Component
private ArchetypeManager manager

selector

@Component
private ArchetypeSelector selector

configurator

@Component
private ArchetypeGenerationConfigurator configurator

invoker

@Component
private org.apache.maven.shared.invoker.Invoker invoker

archetypeArtifactId

@Parameter(property="archetypeArtifactId")
private java.lang.String archetypeArtifactId

The archetype's artifactId.

archetypeGroupId

@Parameter(property="archetypeGroupId")
private java.lang.String archetypeGroupId

The archetype's groupId.

archetypeVersion

@Parameter(property="archetypeVersion")
private java.lang.String archetypeVersion

The archetype's version.

archetypeRepository

@Parameter(property="archetypeRepository")
private java.lang.String archetypeRepository

The archetype's repository.

archetypeCatalog

@Parameter(property="archetypeCatalog",
           defaultValue="remote,local")
private java.lang.String archetypeCatalog

The archetype catalogs to use to build a list and let the user choose from. It is a comma separated list of catalogs. Catalogs use the following schemes:

• 'file://...' with archetype-catalog.xml automatically appended when pointing to a directory
• 'http://...' or 'https://...' with archetype-catalog.xml always appended
• 'local' which is the shortcut for 'file://~/.m2/archetype-catalog.xml'
• 'remote' which is the shortcut for Maven Central repository, ie 'http://repo.maven.apache.org/maven2'
• 'internal' which is an internal catalog

Since 2.0-alpha-5, default value is no longer internal,local but remote,local. If Maven Central repository catalog file is empty, internal catalog is used instead.

localRepository

@Parameter(defaultValue="${localRepository}",
           readonly=true,
           required=true)
private org.apache.maven.artifact.repository.ArtifactRepository localRepository

Local Maven repository.

remoteArtifactRepositories

@Parameter(defaultValue="${project.remoteArtifactRepositories}",
           readonly=true,
           required=true)
private java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> remoteArtifactRepositories

List of remote repositories used by the resolver.

interactiveMode

@Parameter(property="interactiveMode",
           defaultValue="${settings.interactiveMode}",
           required=true)
private java.lang.Boolean interactiveMode

User settings used to check the interactiveMode.

basedir

@Parameter(defaultValue="${basedir}")
private java.io.File basedir

session

@Parameter(defaultValue="${session}",
           readonly=true)
private org.apache.maven.execution.MavenSession session

goals

@Parameter(property="goals")
private java.lang.String goals

Additional goals to immediately run on the project created from the archetype.

filter

@Parameter(property="filter")
private java.lang.String filter

Applying some filter on displayed archetypes list: format is artifactId or groupId:artifactId.

• org.apache: -> displays all archetypes which contain org.apache in groupId
• :jee or jee -> displays all archetypes which contain jee in artifactId
• org.apache:jee -> displays all archetypes which contain org.apache in groupId AND jee in artifactId

Since:

2.1

Constructor Detail

CreateProjectFromArchetypeMojo

public CreateProjectFromArchetypeMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

invokePostArchetypeGenerationGoals

private void invokePostArchetypeGenerationGoals(java.lang.String goals,
                                                java.lang.String artifactId)
                                         throws org.apache.maven.plugin.MojoExecutionException,
                                                org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException