org.apache.maven.archetype

Interface ArchetypeManager

All Known Implementing Classes:

DefaultArchetypeManager

public interface ArchetypeManager

Author:

Jason van Zyl

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROLE

Method Summary

Modifier and Type	Method and Description
File	archiveArchetype(File archetypeDirectory, File outputDirectory, String finalName) Deprecated. replaced by archetype plugin's JarMojo using maven-archiver component for Reproducible Builds
ArchetypeCreationResult	createArchetypeFromProject(ArchetypeCreationRequest request) A command to create an archetype from an existing Maven project given the supplied creation request.
ArchetypeGenerationResult	generateProjectFromArchetype(ArchetypeGenerationRequest request) A command to generate a Maven project from an archetype given the supplied generation request.
ArchetypeCatalog	getInternalCatalog() Gives the catalog of archetypes internal to the plugin.
ArchetypeCatalog	getLocalCatalog(ProjectBuildingRequest buildingRequest) Gives the catalog of archetypes located in the given path.
ArchetypeCatalog	getRemoteCatalog(ProjectBuildingRequest buildingRequest) Gives the catalog of archetypes located at https://repo.maven.apache.org/maven2/archetype-catalog.xml.
void	updateLocalCatalog(ProjectBuildingRequest buildingRequest, Archetype archetype)

Field Detail

ROLE

static final String ROLE

Method Detail

createArchetypeFromProject

ArchetypeCreationResult createArchetypeFromProject(ArchetypeCreationRequest request)

A command to create an archetype from an existing Maven project given the supplied creation request.

Parameters:

request -

Returns:

The result of creating the archetype from the existing project. It contains any errors that might have occurred.

generateProjectFromArchetype

ArchetypeGenerationResult generateProjectFromArchetype(ArchetypeGenerationRequest request)

A command to generate a Maven project from an archetype given the supplied generation request.

Parameters:

request -

Returns:

The result of creating the project from the existing archetype. It contains any errors that might have occurred.

getInternalCatalog

ArchetypeCatalog getInternalCatalog()

Gives the catalog of archetypes internal to the plugin.

Returns:

the catalog.

getLocalCatalog

ArchetypeCatalog getLocalCatalog(ProjectBuildingRequest buildingRequest)

Gives the catalog of archetypes located in the given path. if path is a file, it used as is. if path is a directory, archetype-catalog.xml is appended to it.

Parameters:

buildingRequest - the catalog file path or directory containing the catalog file.

Returns:

the catalog.

getRemoteCatalog

ArchetypeCatalog getRemoteCatalog(ProjectBuildingRequest buildingRequest)

Gives the catalog of archetypes located at https://repo.maven.apache.org/maven2/archetype-catalog.xml.

Parameters:

buildingRequest - TODO

Returns:

the catalog.

archiveArchetype

@Deprecated
File archiveArchetype(File archetypeDirectory,
                                  File outputDirectory,
                                  String finalName)
                           throws DependencyResolutionRequiredException,
                                  IOException

Deprecated. replaced by archetype plugin's JarMojo using maven-archiver component for Reproducible Builds

Creates a jar file for an archetype.

Parameters:

archetypeDirectory -

outputDirectory -

finalName -

Returns:

The File to the generated jar

Throws:

DependencyResolutionRequiredException

IOException

updateLocalCatalog

void updateLocalCatalog(ProjectBuildingRequest buildingRequest,
                        Archetype archetype)