Package com.intellij.projectImport

Class ProjectOpenProcessor

java.lang.Object

com.intellij.projectImport.ProjectOpenProcessor

Direct Known Subclasses:

GradleProjectOpenProcessor, ProjectOpenProcessorBase

public abstract class ProjectOpenProcessor
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<ProjectOpenProcessor>	EXTENSION_POINT_NAME

Constructor Summary

Constructors

Constructor and Description
ProjectOpenProcessor()

Method Summary

Modifier and Type	Method and Description
int	askConfirmationForOpeningProject(VirtualFile file, Project project) If known that a user tries to open some project, ask if the user wants to open it as a plain file or as a project.
boolean	canImportProjectAfterwards() Returns true if this processor is able to import the project after it has been opened in IDEA.
abstract boolean	canOpenProject(VirtualFile file)
abstract Project	doOpenProject(VirtualFile virtualFile, Project projectToClose, boolean forceOpenInNewFrame)
javax.swing.Icon	getIcon()
javax.swing.Icon	getIcon(VirtualFile file)
static ProjectOpenProcessor	getImportProvider(VirtualFile file)
static ProjectOpenProcessor	getImportProvider(VirtualFile file, boolean onlyIfExistingProjectFile)
abstract java.lang.String	getName()
void	importProjectAfterwards(Project project, VirtualFile file) Import the project after it has already been opened in IDEA.
boolean	isProjectFile(VirtualFile file)
boolean	isStrongProjectInfoHolder()
boolean	lookForProjectsInDirectory() Allow opening a directory directly if the project files are located in that directory.

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION_POINT_NAME

public static final ExtensionPointName<ProjectOpenProcessor> EXTENSION_POINT_NAME

Constructor Detail

ProjectOpenProcessor

public ProjectOpenProcessor()

Method Detail

getName

public abstract java.lang.String getName()

getIcon

public javax.swing.Icon getIcon()

getIcon

public javax.swing.Icon getIcon(VirtualFile file)

canOpenProject

public abstract boolean canOpenProject(VirtualFile file)

isProjectFile

public boolean isProjectFile(VirtualFile file)

askConfirmationForOpeningProject

public int askConfirmationForOpeningProject(VirtualFile file,
                                            Project project)

If known that a user tries to open some project, ask if the user wants to open it as a plain file or as a project.

Returns:

Messages.YES -> Open as a project, Messages.NO -> Open as a plain file, Messages.CANCEL -> Don't open.

doOpenProject

public abstract Project doOpenProject(VirtualFile virtualFile,
                                      Project projectToClose,
                                      boolean forceOpenInNewFrame)

lookForProjectsInDirectory

public boolean lookForProjectsInDirectory()

Allow opening a directory directly if the project files are located in that directory.

Returns:

true if project files are searched inside the selected directory, false if the project files must be selected directly.

canImportProjectAfterwards

public boolean canImportProjectAfterwards()

Returns true if this processor is able to import the project after it has been opened in IDEA.

See Also:

importProjectAfterwards(Project, VirtualFile)

importProjectAfterwards

public void importProjectAfterwards(Project project,
                                    VirtualFile file)

Import the project after it has already been opened in IDEA.

See Also:

canImportProjectAfterwards()

getImportProvider

public static ProjectOpenProcessor getImportProvider(VirtualFile file)

getImportProvider

public static ProjectOpenProcessor getImportProvider(VirtualFile file,
                                                     boolean onlyIfExistingProjectFile)

Parameters:

onlyIfExistingProjectFile - when true, doesn't return 'generic' providers that can open any non-project directory/text file (e.g. PlatformProjectOpenProcessor)

isStrongProjectInfoHolder

public boolean isStrongProjectInfoHolder()

Returns:

true if this open processor should be ranked over general .idea and .ipr files even if those exist.