Package com.intellij.ide.util.projectWizard.importSources

Class ProjectStructureDetector

java.lang.Object

com.intellij.ide.util.projectWizard.importSources.ProjectStructureDetector

Direct Known Subclasses:

CloudGitProjectStructureDetector, DefaultProjectStructureDetector, JavaSourceRootDetector, MvcProjectStructureDetector

public abstract class ProjectStructureDetector
extends java.lang.Object

Override this class to provide automatic detection of modules and libraries for 'Create from existing sources' mode of the new project/module wizard.

The implementation should be registered in your plugin.xml:

 <extensions defaultExtensionNs="com.intellij">
   <projectStructureDetector implementation="qualified-class-name"/>
 </extensions>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProjectStructureDetector.DirectoryProcessingResult

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<ProjectStructureDetector>	EP_NAME

Constructor Summary

Constructors

Constructor and Description
ProjectStructureDetector()

Method Summary

Modifier and Type	Method and Description
java.util.List<ModuleWizardStep>	createWizardSteps(ProjectFromSourcesBuilder builder, ProjectDescriptor projectDescriptor, javax.swing.Icon stepIcon) Return additional wizard steps which will be shown if some roots are detected by this detector
abstract ProjectStructureDetector.DirectoryProcessingResult	detectRoots(java.io.File dir, java.io.File [] children, java.io.File base, java.util.List<DetectedProjectRoot> result) This methods is called recursively for all directories under the selected root directory.
java.lang.String	getDetectorId()
void	setupProjectStructure(java.util.Collection<DetectedProjectRoot> roots, ProjectDescriptor projectDescriptor, ProjectFromSourcesBuilder builder) Setup modules and libraries for the selected roots

Methods inherited from class java.lang.Object

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

Field Detail

EP_NAME

public static final ExtensionPointName<ProjectStructureDetector> EP_NAME

Constructor Detail

ProjectStructureDetector

public ProjectStructureDetector()

Method Detail

detectRoots

public abstract ProjectStructureDetector.DirectoryProcessingResult detectRoots(java.io.File dir,
                                                                               java.io.File [] children,
                                                                               java.io.File base,
                                                                               java.util.List<DetectedProjectRoot> result)

This methods is called recursively for all directories under the selected root directory.

Parameters:

dir - current directory

children - its children

base - the root directory in which project files are detected. All detected roots must be located under this directory.

result - list of detected roots

Returns:

ProjectStructureDetector.DirectoryProcessingResult.PROCESS_CHILDREN if children of dir need to be processed by this detector

ProjectStructureDetector.DirectoryProcessingResult.SKIP_CHILDREN to skip all children of dir from processing

ProjectStructureDetector.DirectoryProcessingResult.skipChildrenAndParentsUpTo(java.io.File)(parent) to skip all directories under parent from processing. parent must be an ancestor of dir or dir itself

createWizardSteps

public java.util.List<ModuleWizardStep> createWizardSteps(ProjectFromSourcesBuilder builder,
                                                          ProjectDescriptor projectDescriptor,
                                                          javax.swing.Icon stepIcon)

Return additional wizard steps which will be shown if some roots are detected by this detector

getDetectorId

public java.lang.String getDetectorId()

setupProjectStructure

public void setupProjectStructure(java.util.Collection<DetectedProjectRoot> roots,
                                  ProjectDescriptor projectDescriptor,
                                  ProjectFromSourcesBuilder builder)

Setup modules and libraries for the selected roots