org.netbeans.modules.maven.api.archetype

Class Archetype

java.lang.Object

org.netbeans.modules.maven.api.archetype.Archetype

public final class Archetype
extends Object

Simple model class to describe a Maven archetype. To be created by ArchetypeProvider implementations, consumed by the New Maven Project wizard.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	deletable

Constructor Summary

Constructors

Constructor and Description
Archetype()
Archetype(boolean deletable)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
org.apache.maven.artifact.Artifact	getArtifact() initially non resolved artifact, need to call resolveArtifacts() before getArtifact().getFile() can be used.
String	getArtifactId()
String	getDescription()
String	getGroupId()
String	getName()
org.apache.maven.artifact.Artifact	getPomArtifact() initially non resolved artifact, need to call resolveArtifacts() before getArtifact().getFile() can be used.
String	getRepository() optional property.
String	getVersion()
int	hashCode()
Map<String,String>	loadRequiredProperties() parses the META-INF/maven/archetype-metadata.xml file within the archetype's jar to get the additional required properties.
void	resolveArtifacts(AggregateProgressHandle hndl) resolve the artifacts associated with the archetype (ideally downloads them to the local repository)
void	setArtifactId(String artifactId)
void	setDescription(String description)
void	setGroupId(String groupId)
void	setName(String name)
void	setRepository(String repo) optional property.
void	setVersion(String version)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

deletable

public final boolean deletable

Constructor Detail

Archetype

public Archetype(boolean deletable)

Archetype

public Archetype()

Method Detail

getArtifactId

public String getArtifactId()

setArtifactId

public void setArtifactId(String artifactId)

getGroupId

public String getGroupId()

setGroupId

public void setGroupId(String groupId)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

getName

@NonNull
public String getName()

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

setRepository

public void setRepository(String repo)

optional property.

Parameters:

repo -

getRepository

public String getRepository()

optional property.

Returns:

getArtifact

public org.apache.maven.artifact.Artifact getArtifact()

initially non resolved artifact, need to call resolveArtifacts() before getArtifact().getFile() can be used.

Returns:

getPomArtifact

public org.apache.maven.artifact.Artifact getPomArtifact()

initially non resolved artifact, need to call resolveArtifacts() before getArtifact().getFile() can be used.

Returns:

resolveArtifacts

public void resolveArtifacts(AggregateProgressHandle hndl)
                      throws org.apache.maven.artifact.resolver.ArtifactResolutionException,
                             org.apache.maven.artifact.resolver.ArtifactNotFoundException

resolve the artifacts associated with the archetype (ideally downloads them to the local repository)

Parameters:

hndl -

Throws:

org.apache.maven.artifact.resolver.ArtifactResolutionException

org.apache.maven.artifact.resolver.ArtifactNotFoundException

loadRequiredProperties

public Map<String,String> loadRequiredProperties()

parses the META-INF/maven/archetype-metadata.xml file within the archetype's jar to get the additional required properties. Assumes resolveArtifacts() was called beforehand

Returns:

required property name as key and default value as map value

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object