Package org.apache.maven.archetype
Interface ArchetypeManager
-
- All Known Implementing Classes:
DefaultArchetypeManager
public interface ArchetypeManager
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ROLE
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description java.io.File
archiveArchetype(java.io.File archetypeDirectory, java.io.File outputDirectory, java.lang.String finalName)
Deprecated.replaced by archetype plugin's JarMojo using maven-archiver component for Reproducible BuildsArchetypeCreationResult
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(org.apache.maven.project.ProjectBuildingRequest buildingRequest)
Gives the catalog of archetypes located in the given path.ArchetypeCatalog
getRemoteCatalog(org.apache.maven.project.ProjectBuildingRequest buildingRequest)
Gives the catalog of archetypes located athttps://repo.maven.apache.org/maven2/archetype-catalog.xml
.java.io.File
updateLocalCatalog(org.apache.maven.project.ProjectBuildingRequest buildingRequest, Archetype archetype)
-
-
-
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(org.apache.maven.project.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(org.apache.maven.project.ProjectBuildingRequest buildingRequest)
Gives the catalog of archetypes located athttps://repo.maven.apache.org/maven2/archetype-catalog.xml
.- Parameters:
buildingRequest
- TODO- Returns:
- the catalog.
-
archiveArchetype
@Deprecated java.io.File archiveArchetype(java.io.File archetypeDirectory, java.io.File outputDirectory, java.lang.String finalName) throws org.apache.maven.artifact.DependencyResolutionRequiredException, java.io.IOException
Deprecated.replaced by archetype plugin's JarMojo using maven-archiver component for Reproducible BuildsCreates a jar file for an archetype.- Parameters:
archetypeDirectory
-outputDirectory
-finalName
-- Returns:
- The File to the generated jar
- Throws:
org.apache.maven.artifact.DependencyResolutionRequiredException
java.io.IOException
-
updateLocalCatalog
java.io.File updateLocalCatalog(org.apache.maven.project.ProjectBuildingRequest buildingRequest, Archetype archetype)
-
-