org.eclipse.m2e.core.internal.archetype

Class ArchetypeManager

java.lang.Object

org.eclipse.m2e.core.internal.archetype.ArchetypeManager

public class ArchetypeManager
extends Object

Archetype Manager

Author:

Eugene Kuleshov

Constructor Summary

Constructors

Constructor and Description
ArchetypeManager(File configFile)

Method Summary

Methods

Modifier and Type	Method and Description
void	addArchetypeCatalogFactory(ArchetypeCatalogFactory factory)
<T extends ArchetypeCatalogFactory> T	findParentCatalogFactory(org.apache.maven.archetype.catalog.Archetype a, Class<T> type)
ArchetypeCatalogFactory	getArchetypeCatalogFactory(String catalogId)
Collection<ArchetypeCatalogFactory>	getArchetypeCatalogs()
org.apache.maven.artifact.repository.ArtifactRepository	getArchetypeRepository(org.apache.maven.archetype.catalog.Archetype archetype) Gets the remote ArtifactRepository of the given Archetype, or null if none is found.
List<?>	getRequiredProperties(org.apache.maven.archetype.catalog.Archetype archetype, org.apache.maven.artifact.repository.ArtifactRepository remoteArchetypeRepository, org.eclipse.core.runtime.IProgressMonitor monitor) Gets the required properties of an Archetype.
void	readCatalogs()
void	removeArchetypeCatalogFactory(String catalogId)
void	saveCatalogs()

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchetypeManager

public ArchetypeManager(File configFile)

Method Detail

getArchetypeCatalogs

public Collection<ArchetypeCatalogFactory> getArchetypeCatalogs()

Returns:

Collection of ArchetypeCatalogFactory

addArchetypeCatalogFactory

public void addArchetypeCatalogFactory(ArchetypeCatalogFactory factory)

removeArchetypeCatalogFactory

public void removeArchetypeCatalogFactory(String catalogId)

getArchetypeCatalogFactory

public ArchetypeCatalogFactory getArchetypeCatalogFactory(String catalogId)

readCatalogs

public void readCatalogs()
                  throws IOException

Throws:

IOException

saveCatalogs

public void saveCatalogs()
                  throws IOException

Throws:

IOException

findParentCatalogFactory

public <T extends ArchetypeCatalogFactory> T findParentCatalogFactory(org.apache.maven.archetype.catalog.Archetype a,
                                                             Class<T> type)
                                                           throws org.eclipse.core.runtime.CoreException

Returns:

the archetypeCatalogFactory containing the archetype parameter, null if none was found.

Throws:

org.eclipse.core.runtime.CoreException

getArchetypeRepository

public org.apache.maven.artifact.repository.ArtifactRepository getArchetypeRepository(org.apache.maven.archetype.catalog.Archetype archetype)
                                                                               throws org.eclipse.core.runtime.CoreException

Gets the remote ArtifactRepository of the given Archetype, or null if none is found. The repository url is extracted from Archetype.getRepository(), or, if it has none, the remote catalog the archetype is found in. The ArtifactRepository id is set to archetypeId+"-repo", to enable authentication on that repository.

Parameters:

archetype -

Returns:

the remote ArtifactRepository of the given Archetype, or null if none is found.

Throws:

org.eclipse.core.runtime.CoreException

See Also:

http://maven.apache.org/archetype/maven-archetype-plugin/faq.html

getRequiredProperties

public List<?> getRequiredProperties(org.apache.maven.archetype.catalog.Archetype archetype,
                            org.apache.maven.artifact.repository.ArtifactRepository remoteArchetypeRepository,
                            org.eclipse.core.runtime.IProgressMonitor monitor)
                              throws org.apache.maven.archetype.exception.UnknownArchetype,
                                     org.eclipse.core.runtime.CoreException

Gets the required properties of an Archetype.

Parameters:

archetype - the archetype possibly declaring required properties

remoteArchetypeRepository - the remote archetype repository, can be null.

monitor - the progress monitor, can be null.

Returns:

the required properties of the archetypes, null if none is found.

Throws:

org.apache.maven.archetype.exception.UnknownArchetype - thrown if no archetype is can be resolved

org.eclipse.core.runtime.CoreException