org.netbeans.modules.maven.api.archetype

Class ArchetypeWizards

java.lang.Object

org.netbeans.modules.maven.api.archetype.ArchetypeWizards

public class ArchetypeWizards
extends Object

Utilities for creating New Project wizards based on maven-archetype-plugin.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TEMPLATE_FOLDER Customary location of Maven project templates.

Method Summary

Modifier and Type	Method and Description
static org.netbeans.modules.maven.model.ModelOperation<org.netbeans.modules.maven.model.pom.POMModel>	addDependencyOperation(ProjectInfo info, String type)
static WizardDescriptor.Panel<WizardDescriptor>	basicWizardPanel(org.netbeans.validation.api.ui.ValidationGroup vg, boolean isFinish, Archetype archetype)
static void	createFromArchetype(File projDir, ProjectInfo vi, Archetype arch, Map<String,String> additionalProperties, boolean updateLastUsedProjectDir) Run a single archetype.
static WizardDescriptor.InstantiatingIterator<?>	definedArchetype(String groupId, String artifactId, String version, String repository) Deprecated. use the variant with template title name
static WizardDescriptor.InstantiatingIterator<?>	definedArchetype(String groupId, String artifactId, String version, String repository, String title) Wizard iterator using a predetermined archetype.
static WizardDescriptor.InstantiatingIterator<?>	definedArchetype(String groupId, String artifactId, String version, String repository, String title, Map<String,String> defaultProps)
static void	logUsage(String groupId, String artifactId, String version) Log new project usage.
static Set<FileObject>	openProjects(File dirF, File mainProjectDir) Opens newly created Maven projects.

Methods inherited from class java.lang.Object

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

Field Detail

TEMPLATE_FOLDER

public static final String TEMPLATE_FOLDER

Customary location of Maven project templates.

See Also:

TemplateRegistration.folder(), Constant Field Values

Method Detail

createFromArchetype

public static void createFromArchetype(File projDir,
                                       ProjectInfo vi,
                                       Archetype arch,
                                       @NullAllowed
                                       Map<String,String> additionalProperties,
                                       boolean updateLastUsedProjectDir)
                                throws IOException

Run a single archetype.

Parameters:

projDir - the new project directory (must be normalized first!) (note: parent dir is actually passed to plugin, i.e. assumes that project name matches this basedir)

vi - metadata for new project

arch - the archetype to process

additionalProperties - any additional archetype properties, or null

updateLastUsedProjectDir - true to update last-used project directory for next wizard run

Throws:

IOException

openProjects

public static Set<FileObject> openProjects(File dirF,
                                           File mainProjectDir)
                                    throws IOException

Opens newly created Maven projects.

Parameters:

dirF - the top-level dir to check in

mainProjectDir - the dir containing the main project, or null

Returns:

set of project directories

Throws:

IOException

logUsage

public static void logUsage(String groupId,
                            String artifactId,
                            String version)

Log new project usage.

addDependencyOperation

public static org.netbeans.modules.maven.model.ModelOperation<org.netbeans.modules.maven.model.pom.POMModel> addDependencyOperation(ProjectInfo info,
                                                                                                                                    String type)

basicWizardPanel

public static WizardDescriptor.Panel<WizardDescriptor> basicWizardPanel(org.netbeans.validation.api.ui.ValidationGroup vg,
                                                                        boolean isFinish,
                                                                        @NullAllowed
                                                                        Archetype archetype)

definedArchetype

@Deprecated
public static WizardDescriptor.InstantiatingIterator<?> definedArchetype(String groupId,
                                                                                     String artifactId,
                                                                                     String version,
                                                                                     @NullAllowed
                                                                                     String repository)

Deprecated. use the variant with template title name

Wizard iterator using a predetermined archetype.

Since:

2.28

See Also:

TemplateRegistration, ArchetypeWizards.TEMPLATE_FOLDER

definedArchetype

public static WizardDescriptor.InstantiatingIterator<?> definedArchetype(String groupId,
                                                                         String artifactId,
                                                                         String version,
                                                                         @NullAllowed
                                                                         String repository,
                                                                         String title)

Wizard iterator using a predetermined archetype.

Since:

2.63

See Also:

TemplateRegistration, ArchetypeWizards.TEMPLATE_FOLDER

definedArchetype

public static WizardDescriptor.InstantiatingIterator<?> definedArchetype(String groupId,
                                                                         String artifactId,
                                                                         String version,
                                                                         @NullAllowed
                                                                         String repository,
                                                                         String title,
                                                                         Map<String,String> defaultProps)

Since:

2.138