org.apache.maven.archetype.catalog

Class Archetype

java.lang.Object

org.apache.maven.archetype.catalog.Archetype

All Implemented Interfaces:

java.io.Serializable

public class Archetype
extends java.lang.Object
implements java.io.Serializable

Informations to point to an Archetype referenced in the catalog.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	artifactId The artifactId of the archetype.
private java.lang.String	description The description of the archetype.
private java.util.List<java.lang.String>	goals Field goals.
private java.lang.String	groupId The groupId of the archetype.
private java.util.Properties	properties Field properties.
private java.lang.String	repository The repository where to find the archetype.
private java.lang.String	version The version of the archetype.

Constructor Summary

Constructors

Constructor and Description
Archetype()

Method Summary

Modifier and Type	Method and Description
void	addGoal(java.lang.String string) Method addGoal.
void	addProperty(java.lang.String key, java.lang.String value) Method addProperty.
boolean	equals(java.lang.Object object)
java.lang.String	getArtifactId() Get the artifactId of the archetype.
java.lang.String	getDescription() Get the description of the archetype.
java.util.List<java.lang.String>	getGoals() Method getGoals.
java.lang.String	getGroupId() Get the groupId of the archetype.
java.util.Properties	getProperties() Method getProperties.
java.lang.String	getRepository() Get the repository where to find the archetype.
java.lang.String	getVersion() Get the version of the archetype.
int	hashCode()
void	removeGoal(java.lang.String string) Method removeGoal.
void	setArtifactId(java.lang.String artifactId) Set the artifactId of the archetype.
void	setDescription(java.lang.String description) Set the description of the archetype.
void	setGoals(java.util.List<java.lang.String> goals) Set goals to execute after the creation of the project.
void	setGroupId(java.lang.String groupId) Set the groupId of the archetype.
void	setProperties(java.util.Properties properties) Set properties that will be used during the execution of addition goals after the creation of the project.
void	setRepository(java.lang.String repository) Set the repository where to find the archetype.
void	setVersion(java.lang.String version) Set the version of the archetype.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

groupId

private java.lang.String groupId

The groupId of the archetype.

artifactId

private java.lang.String artifactId

The artifactId of the archetype.

version

private java.lang.String version

The version of the archetype. RELEASE is a valid version.

repository

private java.lang.String repository

The repository where to find the archetype. When omitted, the archetype is searched for in the repository where the catalog comes from.

description

private java.lang.String description

The description of the archetype.

goals

private java.util.List<java.lang.String> goals

Field goals.

properties

private java.util.Properties properties

Field properties.

Constructor Detail

Archetype

public Archetype()

Method Detail

addGoal

public void addGoal(java.lang.String string)

Method addGoal.

Parameters:

string -

addProperty

public void addProperty(java.lang.String key,
                        java.lang.String value)

Method addProperty.

Parameters:

key -

value -

getArtifactId

public java.lang.String getArtifactId()

Get the artifactId of the archetype.

Returns:

String

getDescription

public java.lang.String getDescription()

Get the description of the archetype.

Returns:

String

getGoals

public java.util.List<java.lang.String> getGoals()

Method getGoals.

Returns:

List

getGroupId

public java.lang.String getGroupId()

Get the groupId of the archetype.

Returns:

String

getProperties

public java.util.Properties getProperties()

Method getProperties.

Returns:

Properties

getRepository

public java.lang.String getRepository()

Get the repository where to find the archetype. When omitted, the archetype is searched for in the repository where the catalog comes from.

Returns:

String

getVersion

public java.lang.String getVersion()

Get the version of the archetype. RELEASE is a valid version.

Returns:

String

removeGoal

public void removeGoal(java.lang.String string)

Method removeGoal.

Parameters:

string -

setArtifactId

public void setArtifactId(java.lang.String artifactId)

Set the artifactId of the archetype.

Parameters:

artifactId -

setDescription

public void setDescription(java.lang.String description)

Set the description of the archetype.

Parameters:

description -

setGoals

public void setGoals(java.util.List<java.lang.String> goals)

Set goals to execute after the creation of the project.

Parameters:

goals -

setGroupId

public void setGroupId(java.lang.String groupId)

Set the groupId of the archetype.

Parameters:

groupId -

setProperties

public void setProperties(java.util.Properties properties)

Set properties that will be used during the execution of addition goals after the creation of the project.

Parameters:

properties -

setRepository

public void setRepository(java.lang.String repository)

Set the repository where to find the archetype. When omitted, the archetype is searched for in the repository where the catalog comes from.

Parameters:

repository -

setVersion

public void setVersion(java.lang.String version)

Set the version of the archetype. RELEASE is a valid version.

Parameters:

version -

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object